MeeGo wiki - User contributions [en]

UMMS User Manual

2013-02-05T13:32:51Z

Dominig: /* Source code */

= UMMS User Manual and Sample code =

== Introduction ==
This page is the user manual and some sample code for the Universal Multi Media Service (UMMS). 
The UMMS general description is on the '''[[Umms|main page]]'''.
== Source code ==
You can get the code from:
git://gitorious.org/meego-middleware/umms.git

Mailing for question
https://lists.tizen.org/listinfo/general

== Service Name ==
com.UMMS

== Objects and Interfaces ==
''ObjectManager'': Object to create and remove ''MediaPlayer'' object.
Path: /com/UMMS/ObjectManager
Interface: com.UMMS.ObjectManager.iface

''MediaPlayer'': Player object to control the playback of media assets.
Path: Returned by ''ObjectManager''
Interface: com.UMMS.MediaPlayer

''AudioManager'': Object to manage the system audio output.
Path: /com/UMMS/AudioManager
Interface: com.UMMS.AudioManger

''VideoOutput'': Object to control the display.
Path: /com/UMMS/VideoOutput
Interface: com.UMMS.VideoOutput

''PlayingContentMetadataViewer'': Object to provide the metadata of all currently playing content.
Path: /com/UMMS/PlayingContentMetadataViewer
Interface: com.UMMS.PlayingContentMetadataViewer

== API Reference ==
* '''''Interface com.UMMS.ObjectManager.iface'''''

Methods:

'''RequestMediaPlayer(s(out): object_path)'''
Request a ''MediaPlayer'' object operate in attended-execution mode. The ''ObjectManager'' will create a new ''MediaPlayer'' object,
register the object on the bus and return the object path to client.
Parameters:
object_path(out): The object path belongs to the newly created ''MediaPlayer'' object.

'''RequestMediaPlayerUnattended(d: time_to_execution, s(out): token, s(out): object_path)'''
Request a ''MediaPlayer'' object operate in unattended-execution mode. The ''ObjectManager'' will create a new ''MediaPlayer'' object,
register it on the bus and return the object path to client.
Parameters:
time_to_execution: Times in seconds for which this ''MediaPlayer'' object keep alive.
token(out): The unique token belongs to this execution. Application can use it to identify the execution log file which
named by the token.
object_path(out): The object path belongs to the newly created ''MediaPlayer'' object.

'''RequestScheduledRecorder(d: start_time, d: duration, s: uri, s: location, s(out): token, s(out): object_path)'''
Request a ''MediaPlayer'' object operate in unattended-execution mode and schedule it to record the media pointed by "uri". The ''ObjectManager'' will create a
new ''MediaPlayer'' object, register it on the bus and return the object path to client.
Parameters:
start_time: The delay to start recording in seconds.
duration: How long to record, in seconds.
uri: Specify the media to record.
location: Location to store the recorded media.
token(out): The unique token belongs to this execution. Application can use it to identify the execution log file which
named by the token.
object_path(out): The object path belongs to the newly created ''MediaPlayer'' object.

'''RemoveMediaPlayer(s: object_path)'''
Remove the ''MediaPlayer'' object which was exposed on the object_path.
Parameters:
object_path: The path on which this object was exposed.

* '''''Interface com.UMMS.MediaPlayer'''''

Methods:

'''SetUri(s: uri)'''
Set URI to UMMS.
Parameters:
uri: URI to set.

'''SetSubtitleUri(s: sub_uri)'''
Set subtitle URI to UMMS.
Parameters:
sub_uri: URI to identify the subtitle file.

'''GetCurrentUri(s(out): current_uri)'''
Get current URI.
Parameters:
current_uri(out): current URI.

'''SetTarget(i: type, a{sv}: param)'''
Set video target and pass all target parameters to UMMS. The video target is where your decoded video data should be rendered.
Parameters:
type: The type of video target.
0:XWindow, the video data will be rendered on the X Window.
1:DataCopy, the video data will be copied to a memory instead of directly rendering. E.g. copied to a GL Texture.
2:Socket, the video data will sent to a socket.
3:ReservedType0, reserved for custom target.
4:ReservedType1, reserved for custom target.
5:ReservedType2, reserved for custom target.
6:ReservedType3, reserved for custom target.
param: The list of key-value pair to specify the attributes of the target. The definition of attribute structure is
target-specific and up to the implementor. The UMMS framwork just defined the XWindow target attribute:
Key Value
"window-id" value of "i" type indicates the window id.

'''Play()'''

'''Pause()'''

'''Stop()'''

'''SetPosition(x: pos)'''
Seek to position.
Parameters:
pos: Stream position in millisecond.

'''GetPosition(x(out): pos)'''
Get the current position of stream in millisecond.
Parameters:
pos(out): The current stream position.

'''SetPlaybackRate(d: rate）'''
Set the playback rate.
Parameters:
rate: rate to playback the media asset.

'''GetPlaybackRate(d(out): rate）'''
Get current playback rate.
Parameters:
rate(out): The current playback rate.

'''SetVolume(i: volume)'''

'''GetVolume(i(out): volume)'''

'''SetVideoSize(u: x, u: y, u: w, u: h)'''
Set video dimension.
Paramters:
x: X coordinate of top-left.
y: Y coordinate of top-left.
w: Width of video rectangle.
h: Height of video rectangle.

'''GetVideoSize(u(out): w, u(out): h)'''
Get current width and height of video rectangle.
Parameters:
w(out): Width of current video rectangle.
h(out): Height of current video rectangle.

'''GetBufferedTime(x(out): length_time)'''
Get the approximate duration of playable data downloaded so far in millisecond.
Parameters:
length_time(out): amount of playable data downloaded so far in millisecond.

'''GetBufferedBytes(x(out): length_byte)'''
Get the approximate amount of playable data downloaded so far in bytes.
Parameters:
length_byte(out): amount of playable data downloaded so far in byte.

'''GetMediaSizeTime(x(out): duration)'''
Get the duration of the media.
Parameters:
duration(out): duration in millisecond.

'''GetMediaSizeBytes(x(out): size)'''
Get the total size of the media file.
Parameters:
size(out): total size of the media file.

'''HasVideo(b(out): has_video)'''
Indicates the existance of video stream in the media asset.
Parameters:
has_video(out): True if media asset has video. False otherwise.

'''HasAudio(b(out): has_audio)'''
Indicates the existance of audio stream in the media asset.
Parameters:
has_audio(out): True if media asset has audio. False otherwise.

'''IsStreaming(b(out): is_stream)'''
Indicates whether the URI represents a streaming media.
Parameters:
is_stream(out): True for streamimg media. False otherwise.

'''IsSeekable(b(out): is_seekable)'''
Indicates whether this media asset is seekable.
Parameters:
is_seekable(out): True for seekable. False otherwise.

'''SupportFullScreen(b(out): support_fullscreen)'''
Indicates whether the backend supports a fullscreen mode.
Parameters:
support_fullscreen(out): True if backend supports fullscreen. False otherwise.

'''GetPlayerState(i(out): current_state)'''
Get current state of ''MediaPlayer'' object.
Parameters:
current_state(out):
0:Null,
1:Stopped,
2:Paused,
3:Playing

'''Reply()'''
Response the UMMS server’s heartbeat check. In the attended-execution mode, client should connect to NeedReply
signal with a callback in which Reply() method should be called.

'''SetProxy(a{sv}: param)'''
Set proxy stuffs.
Parameters:
param: A list of key-value pair to sepcify the proxy attributes.
The attribute structure is defined as:
Key Value
"proxy-uri" value of "s" type indicates HTTP proxy server URIl
"proxy-id" value of "s" type indicates HTTP proxy user id for authentication.
"proxy-pw" value of "s" type indicates HTTP proxy user password for authentication

'''Suspend()'''
Suspend current execution of player. After this invoking, all the resources ocuppied by this session will be released.

'''Restore()'''
Play the media asset from the position at where it suspended.

'''GetCurrentVideo(i(out): current_video)'''
Get current playing video stream.
Parameters:
current_video(out): stream number of current playing video.

'''GetCurrentAudio(i(out): current_audio)'''
Get current playing audio stream.
Parameters:
current_audio(out): stream number of current playing audio.

'''GetCurrentSubtitle(i(out): current_sub)'''
Get current playing subtitle stream.
Parameters:
current_sub(out): stream number of current playing subtitle.

'''SetCurrentVideo(i: current_video)'''
Choose the video stream to play.
Parameters:
current_video: stream number of video stream choosed to play.

'''SetCurrentAudio(i: current_audio)'''
Choose the audio stream to play.
Parameters:
current_audio: stream number of audio stream choosed to play.

'''SetCurrentSubtitle(i: current_sub)'''
Choose the subtitle stream to play. This method is for the media asset with embedded subtitle.
Parameters:
current_sub: stream number of subtitle stream choosed to play.

'''GetVideoNum(i(out): video_num)'''
Get total number of video streams.
Parameters:
video_num(out): Total number of video streams.

'''GetAudioNum(i(out): audio_num)'''
Get total number of audio streams.
Parameters:
audio_num(out): Total number of audio streams.

'''SetBufferDepth(i: format, x: buf_depth)'''
Set buffer depth when buffering network streams.
Parameters:
format: 0 for Time, 1 for Btye.
buf_depth: The depth to buffer data.

'''GetBufferDepth(i: format, x(out): buf_depth)'''
Get buffer depth.
Parameters:
format: 0 for Time, 1 for Btye.
buf_depth(out): The depth to buffer data.

'''SetMute(i: is_mute)'''
Mute the audio.
Parameters:
is_mute: 0 for unmute, 1 for mute.

'''IsMute(i(out): is_mute)'''
Get the mute state.
Parameters:
is_mute(out): 0 for unmute, 1 for mute.

'''SetScaleMode(i: mode)'''
Set the scale mode.
Parameters:
mode:
0: do not scale.
1: fill entire target, regardless of original video aspect ratio.
2: scale the video with respect to original video aspect ratio.
3: fill the whole screen but keep the ratio, some part of video may out of screen.

'''GetScaleMode(i(out): mode)'''
Get the scale mode.
Parameters:
mode(out):
0: do not scale.
1: fill entire target, regardless of original video aspect ratio.
2: scale the video with respect to original video aspect ratio.
3: fill the whole screen but keep the ratio, some part of video may out of screen.

'''GetVideoCodec(i: num, s(out): video_codec)'''
Get the codec of video stream specified by the "num".
Parameters:
num: video stream number.
video_codec(out): codec string.

'''GetAudioCodec(i: num, s(out): audio_codec)'''
Get the codec of audio stream specified by the "num".
Parameters:
num: audio stream number.
audio_codec(out): codec string.

'''GetVideoBitrate(i: num, i(out): video_bitrate)'''
Get the bitrate of video stream specified by the "num".
Parameters:
num: video stream number.
video_bitrate(out): bitrate of the video stream.

'''GetAudioBitrate(i: channel, i(out): audio_bitrate)'''
Get the bitrate of audio stream specified by the "num".
Parameters:
num: audio stream number.
audio_bitrate(out): bitrate of the audio stream.

'''GetEncapsulation(s(out): encapsulation)'''
Get the container format.
Parameters:
encapsulation(out): the container format.

'''GetAudioSampleRate(i: num, i(out): sample_rate)'''
Get the sample rate of audio stream specified by the "num".
Parameters:
num: audio stream number.
sample_rate(out): sample rate of the audio stream.

'''GetVideoFrameRate(i: num, i(out): frame_rate_num, i(out): frame_rate_denum)'''
Get the frame rate of video stream specified by the "num".
Parameters:
num: video stream number.
frame_rate_num(out): numerator of frame rate.
frame_rate_denum(out): denumerator of frame rate.

'''GetVideoResolution(i: num, i(out): width, i(out): height)'''
Get the original resolution of the video stream specified by the "num".
Parameters:
num: video stream number.
width(out): width of video.
height(out): height of video.

'''GetVideoAspectRatio(i: num, i(out): ratio_num, i(out): ratio_denum)'''
Get the original aspect ratio of the video stream specified by the "num".
Parameters:
num: video stream number.
ratio_num(out): numerator of the aspect ratio.
ratio_denum(out): denumerator of the aspect ratio.

'''GetProtocolName(s(out): protocol_name)'''
Get the tranport protocol name.
Parameters:
protocol_name(out): name of the protocol.

'''Record(b: to_record, s: location)'''
Start or stop the recording of current playing DVB stream.
Parameters:
to_record: True to start recording, False to stop recording.
location: path to store the record file.

'''GetPat(aa{sv}(out): pat)'''
Get the "Program Association Table".
Parameters:
pat(out): the "Program Association Table".
The structure of pat is a list of mapping table. Each mapping table has two key-value pairs:
Key Value
"program-number" value of "u" type which indicates the program number.
"pid": value of "u" type which indicates the pid of the pat.

'''GetPmt(u(out): program_number, u(out): pcr_pid, aa{sv}(out): stream_info)'''
Get the "Program Map Table" of current playing DVB program.
Parameters:
program_number(out): the number of current playing program.
pcr_pid(out): the pcr pid.
stream_info(out): the information of all elementary streams multiplexed in this program.
The structure of stream_info is a list of mapping table. Each mapping table has two key-value pairs:
Key Value
"stream-type" value of "u" type indicates the stream type.
"pid" value of "u" type indicates the pid of the elementary stream.

'''GetAssociatedDataChannel(s(out): ip, i(out): port)'''
Get the ip and port from which the client can retrive DVB associated data(ts packets).
Parameters:
ip(out): ip string
port(out): port string

Signals:
'''Initialized'''
Pipeline engine initialized.

'''Eof'''
End of file or stream.

'''Error(u: id, s: message)'''
Error happened.
Parameters:
id: error id.
message: error message.

'''Buffering(i: percent)'''
Buffering percent, from 0 to 100.

'''Seeked'''
Seeking done.

'''Stopped'''
Player stopped.

'''PlayerStateChanged(i: old_state, i: new_state)'''
Player state changed.
Parameters:
old_state: previous state of player, value definition is the same as state parameter of GetPlayerState.
new_state: current state of player, value definition is the same as state parameter of GetPlayerState.

'''NeedReply'''
Singal to request the client to reply. This is used for client existence checking. The client should call the Reply() method to response this
signal.

'''Suspended'''
The player has been suspended. That means all the resources ocuppied by this player has been released.

'''Restored'''
The player restored from suspened.

'''NoResource'''
Resource unavailable.

'''VideoTagChanged(i: video_number)'''
The metadata of a video stream changed.
Parameters:
video_number: video stream number.

'''AudioTagChanged(i: audio_number)'''
The metadata of a audio stream changed.
Parameters:
audio_number: audio stream number.

'''TextTagChanged(i: text_number)'''
The metadata of a text stream changed.
Parameters:
text_number: text stream number.

'''RecordStart'''
The recording started.

'''RecordStop'''
The recording stopped.

* '''''Interface: com.UMMS.AudioManger'''''

Methods:
'''SetVolume(i: output_type, i: volume)'''
Set the global audio volume on audio output specified by "output_type".
Parameters:
output_type: output type id.
0, hdmi
1, spidf
2, i2s0
3, i2s1
volume: volume to set, range [0, 100]

'''GetVolume(i: output_type, i(out): volume)'''
Set the global audio volume on audio output specified by "output_type".
Parameters:
output_type: output type id.
volume(out): current volume.

'''SetState(i: output_type, i: state)'''
Mute/Unmute the audio output.
Parameters:
output_type: output type id.
state: 0 to unmute, 1 to mute.

'''GetState(i: output_type, i(out): state)'''
Get the mute state of audio output.
Parameters:
output_type: output type id.
state(out): 0 for unmute, 1 for mute.

* '''''Interface: com.UMMS.VideoOutput'''''

Methods:
'''GetValidVideoOutput(as(out): outputs)'''
Get name of all the outputs.
Parameters:
outputs(out): output names.

'''GetValidMode(s:output_name, as(out): modes)'''
Get valid display modes of a output specified by output_name
Parameters:
output_name：output name.
modes(out): valid display modes.

'''SetMode(s:output_name, s: mode)'''
Set display mode of the output.
Parameters:
output_name：output name.
mode: mode to set.

'''GetMode(s:output_name, s(out): mode)'''
Get current display mode of the output.
Parameters:
output_name：output name.
mode(out): current display mode.

* '''''Interface: com.UMMS.PlayingContentMetadataViewer'''''

Methods:
'''GetPlayingContentMetadata(aa{sv}(out): playing_content_metadata)'''
Get the current playing content metadata.
Parameters:
playing_content_metadata(out): media content metadata
The structure of playing_content_metadata is a list of mapping table. Each mapping table has 3 key-value pairs:
Key Value
"URI" Value of "s" type indicates the current playing URI.
"Title" Value of "s" type indicates the title of the playing media content
"Artist" Value of "s" type indicates the artist of the playing media content

Signals:
'''MetadataUpdated(aa{sv}: metadata)'''
Emitted when a metadata changed. e.g. A new player is requested to play a video.
Parameters:
metadata: The same as playing_content_metadata

== Sample Code ==
This is a sample application written in Python to play a URI by requesting an attended-execution media player instance. You can get the latest code from: git://gitorious.org:meego-middleware/umms.git
<pre>
import dbus
import dbus.mainloop.glib
import dbus.glib

player_iface = None
loop = None

def need_reply_cb ():
player_iface.Reply()

def eof_cb ():
print "EOF...."
loop.quit()

#event loop
dbus.mainloop.glib.DBusGMainLoop(set_as_default=True)

#get the system message deamon
bus=dbus.SystemBus()

#get the 'com.UMMS.ObjectManager.iface'
bus_obj=bus.get_object('com.UMMS', '/com/UMMS/ObjectManager')
obj_mngr=dbus.Interface(bus_obj, 'com.UMMS.ObjectManager.iface')

#request a media player for attended-execution
player_obj_path = obj_mngr.RequestMediaPlayer()
player_obj = bus.get_object("com.UMMS", player_obj_path)
player_iface = dbus.Interface(player_obj, 'com.UMMS.MediaPlayer')

#for the attended-execution, we must connect to the "NeedReply" signal
player_iface.connect_to_signal("NeedReply", need_reply_cb)

#connect other signals you want
player_iface.connect_to_signal("Eof", eof_cb)

#play a URI
player_iface.SetUri("/tmp/sample.mp4")
player_iface.Play()

#event loop
loop = gobject.MainLoop()
loop.run()
</pre>

UMMS User Manual

2013-02-05T13:32:26Z

Dominig: /* Source code */

= UMMS User Manual and Sample code =

== Introduction ==
This page is the user manual and some sample code for the Universal Multi Media Service (UMMS). 
The UMMS general description is on the '''[[Umms|main page]]'''.
== Source code ==
You can get the code from:
git://gitorious.org/meego-middleware/umms.git

Mialing for question
https://lists.tizen.org/listinfo/general

== Service Name ==
com.UMMS

== Objects and Interfaces ==
''ObjectManager'': Object to create and remove ''MediaPlayer'' object.
Path: /com/UMMS/ObjectManager
Interface: com.UMMS.ObjectManager.iface

''MediaPlayer'': Player object to control the playback of media assets.
Path: Returned by ''ObjectManager''
Interface: com.UMMS.MediaPlayer

''AudioManager'': Object to manage the system audio output.
Path: /com/UMMS/AudioManager
Interface: com.UMMS.AudioManger

''VideoOutput'': Object to control the display.
Path: /com/UMMS/VideoOutput
Interface: com.UMMS.VideoOutput

''PlayingContentMetadataViewer'': Object to provide the metadata of all currently playing content.
Path: /com/UMMS/PlayingContentMetadataViewer
Interface: com.UMMS.PlayingContentMetadataViewer

== API Reference ==
* '''''Interface com.UMMS.ObjectManager.iface'''''

Methods:

'''RequestMediaPlayer(s(out): object_path)'''
Request a ''MediaPlayer'' object operate in attended-execution mode. The ''ObjectManager'' will create a new ''MediaPlayer'' object,
register the object on the bus and return the object path to client.
Parameters:
object_path(out): The object path belongs to the newly created ''MediaPlayer'' object.

'''RequestMediaPlayerUnattended(d: time_to_execution, s(out): token, s(out): object_path)'''
Request a ''MediaPlayer'' object operate in unattended-execution mode. The ''ObjectManager'' will create a new ''MediaPlayer'' object,
register it on the bus and return the object path to client.
Parameters:
time_to_execution: Times in seconds for which this ''MediaPlayer'' object keep alive.
token(out): The unique token belongs to this execution. Application can use it to identify the execution log file which
named by the token.
object_path(out): The object path belongs to the newly created ''MediaPlayer'' object.

'''RequestScheduledRecorder(d: start_time, d: duration, s: uri, s: location, s(out): token, s(out): object_path)'''
Request a ''MediaPlayer'' object operate in unattended-execution mode and schedule it to record the media pointed by "uri". The ''ObjectManager'' will create a
new ''MediaPlayer'' object, register it on the bus and return the object path to client.
Parameters:
start_time: The delay to start recording in seconds.
duration: How long to record, in seconds.
uri: Specify the media to record.
location: Location to store the recorded media.
token(out): The unique token belongs to this execution. Application can use it to identify the execution log file which
named by the token.
object_path(out): The object path belongs to the newly created ''MediaPlayer'' object.

'''RemoveMediaPlayer(s: object_path)'''
Remove the ''MediaPlayer'' object which was exposed on the object_path.
Parameters:
object_path: The path on which this object was exposed.

* '''''Interface com.UMMS.MediaPlayer'''''

Methods:

'''SetUri(s: uri)'''
Set URI to UMMS.
Parameters:
uri: URI to set.

'''SetSubtitleUri(s: sub_uri)'''
Set subtitle URI to UMMS.
Parameters:
sub_uri: URI to identify the subtitle file.

'''GetCurrentUri(s(out): current_uri)'''
Get current URI.
Parameters:
current_uri(out): current URI.

'''SetTarget(i: type, a{sv}: param)'''
Set video target and pass all target parameters to UMMS. The video target is where your decoded video data should be rendered.
Parameters:
type: The type of video target.
0:XWindow, the video data will be rendered on the X Window.
1:DataCopy, the video data will be copied to a memory instead of directly rendering. E.g. copied to a GL Texture.
2:Socket, the video data will sent to a socket.
3:ReservedType0, reserved for custom target.
4:ReservedType1, reserved for custom target.
5:ReservedType2, reserved for custom target.
6:ReservedType3, reserved for custom target.
param: The list of key-value pair to specify the attributes of the target. The definition of attribute structure is
target-specific and up to the implementor. The UMMS framwork just defined the XWindow target attribute:
Key Value
"window-id" value of "i" type indicates the window id.

'''Play()'''

'''Pause()'''

'''Stop()'''

'''SetPosition(x: pos)'''
Seek to position.
Parameters:
pos: Stream position in millisecond.

'''GetPosition(x(out): pos)'''
Get the current position of stream in millisecond.
Parameters:
pos(out): The current stream position.

'''SetPlaybackRate(d: rate）'''
Set the playback rate.
Parameters:
rate: rate to playback the media asset.

'''GetPlaybackRate(d(out): rate）'''
Get current playback rate.
Parameters:
rate(out): The current playback rate.

'''SetVolume(i: volume)'''

'''GetVolume(i(out): volume)'''

'''SetVideoSize(u: x, u: y, u: w, u: h)'''
Set video dimension.
Paramters:
x: X coordinate of top-left.
y: Y coordinate of top-left.
w: Width of video rectangle.
h: Height of video rectangle.

'''GetVideoSize(u(out): w, u(out): h)'''
Get current width and height of video rectangle.
Parameters:
w(out): Width of current video rectangle.
h(out): Height of current video rectangle.

'''GetBufferedTime(x(out): length_time)'''
Get the approximate duration of playable data downloaded so far in millisecond.
Parameters:
length_time(out): amount of playable data downloaded so far in millisecond.

'''GetBufferedBytes(x(out): length_byte)'''
Get the approximate amount of playable data downloaded so far in bytes.
Parameters:
length_byte(out): amount of playable data downloaded so far in byte.

'''GetMediaSizeTime(x(out): duration)'''
Get the duration of the media.
Parameters:
duration(out): duration in millisecond.

'''GetMediaSizeBytes(x(out): size)'''
Get the total size of the media file.
Parameters:
size(out): total size of the media file.

'''HasVideo(b(out): has_video)'''
Indicates the existance of video stream in the media asset.
Parameters:
has_video(out): True if media asset has video. False otherwise.

'''HasAudio(b(out): has_audio)'''
Indicates the existance of audio stream in the media asset.
Parameters:
has_audio(out): True if media asset has audio. False otherwise.

'''IsStreaming(b(out): is_stream)'''
Indicates whether the URI represents a streaming media.
Parameters:
is_stream(out): True for streamimg media. False otherwise.

'''IsSeekable(b(out): is_seekable)'''
Indicates whether this media asset is seekable.
Parameters:
is_seekable(out): True for seekable. False otherwise.

'''SupportFullScreen(b(out): support_fullscreen)'''
Indicates whether the backend supports a fullscreen mode.
Parameters:
support_fullscreen(out): True if backend supports fullscreen. False otherwise.

'''GetPlayerState(i(out): current_state)'''
Get current state of ''MediaPlayer'' object.
Parameters:
current_state(out):
0:Null,
1:Stopped,
2:Paused,
3:Playing

'''Reply()'''
Response the UMMS server’s heartbeat check. In the attended-execution mode, client should connect to NeedReply
signal with a callback in which Reply() method should be called.

'''SetProxy(a{sv}: param)'''
Set proxy stuffs.
Parameters:
param: A list of key-value pair to sepcify the proxy attributes.
The attribute structure is defined as:
Key Value
"proxy-uri" value of "s" type indicates HTTP proxy server URIl
"proxy-id" value of "s" type indicates HTTP proxy user id for authentication.
"proxy-pw" value of "s" type indicates HTTP proxy user password for authentication

'''Suspend()'''
Suspend current execution of player. After this invoking, all the resources ocuppied by this session will be released.

'''Restore()'''
Play the media asset from the position at where it suspended.

'''GetCurrentVideo(i(out): current_video)'''
Get current playing video stream.
Parameters:
current_video(out): stream number of current playing video.

'''GetCurrentAudio(i(out): current_audio)'''
Get current playing audio stream.
Parameters:
current_audio(out): stream number of current playing audio.

'''GetCurrentSubtitle(i(out): current_sub)'''
Get current playing subtitle stream.
Parameters:
current_sub(out): stream number of current playing subtitle.

'''SetCurrentVideo(i: current_video)'''
Choose the video stream to play.
Parameters:
current_video: stream number of video stream choosed to play.

'''SetCurrentAudio(i: current_audio)'''
Choose the audio stream to play.
Parameters:
current_audio: stream number of audio stream choosed to play.

'''SetCurrentSubtitle(i: current_sub)'''
Choose the subtitle stream to play. This method is for the media asset with embedded subtitle.
Parameters:
current_sub: stream number of subtitle stream choosed to play.

'''GetVideoNum(i(out): video_num)'''
Get total number of video streams.
Parameters:
video_num(out): Total number of video streams.

'''GetAudioNum(i(out): audio_num)'''
Get total number of audio streams.
Parameters:
audio_num(out): Total number of audio streams.

'''SetBufferDepth(i: format, x: buf_depth)'''
Set buffer depth when buffering network streams.
Parameters:
format: 0 for Time, 1 for Btye.
buf_depth: The depth to buffer data.

'''GetBufferDepth(i: format, x(out): buf_depth)'''
Get buffer depth.
Parameters:
format: 0 for Time, 1 for Btye.
buf_depth(out): The depth to buffer data.

'''SetMute(i: is_mute)'''
Mute the audio.
Parameters:
is_mute: 0 for unmute, 1 for mute.

'''IsMute(i(out): is_mute)'''
Get the mute state.
Parameters:
is_mute(out): 0 for unmute, 1 for mute.

'''SetScaleMode(i: mode)'''
Set the scale mode.
Parameters:
mode:
0: do not scale.
1: fill entire target, regardless of original video aspect ratio.
2: scale the video with respect to original video aspect ratio.
3: fill the whole screen but keep the ratio, some part of video may out of screen.

'''GetScaleMode(i(out): mode)'''
Get the scale mode.
Parameters:
mode(out):
0: do not scale.
1: fill entire target, regardless of original video aspect ratio.
2: scale the video with respect to original video aspect ratio.
3: fill the whole screen but keep the ratio, some part of video may out of screen.

'''GetVideoCodec(i: num, s(out): video_codec)'''
Get the codec of video stream specified by the "num".
Parameters:
num: video stream number.
video_codec(out): codec string.

'''GetAudioCodec(i: num, s(out): audio_codec)'''
Get the codec of audio stream specified by the "num".
Parameters:
num: audio stream number.
audio_codec(out): codec string.

'''GetVideoBitrate(i: num, i(out): video_bitrate)'''
Get the bitrate of video stream specified by the "num".
Parameters:
num: video stream number.
video_bitrate(out): bitrate of the video stream.

'''GetAudioBitrate(i: channel, i(out): audio_bitrate)'''
Get the bitrate of audio stream specified by the "num".
Parameters:
num: audio stream number.
audio_bitrate(out): bitrate of the audio stream.

'''GetEncapsulation(s(out): encapsulation)'''
Get the container format.
Parameters:
encapsulation(out): the container format.

'''GetAudioSampleRate(i: num, i(out): sample_rate)'''
Get the sample rate of audio stream specified by the "num".
Parameters:
num: audio stream number.
sample_rate(out): sample rate of the audio stream.

'''GetVideoFrameRate(i: num, i(out): frame_rate_num, i(out): frame_rate_denum)'''
Get the frame rate of video stream specified by the "num".
Parameters:
num: video stream number.
frame_rate_num(out): numerator of frame rate.
frame_rate_denum(out): denumerator of frame rate.

'''GetVideoResolution(i: num, i(out): width, i(out): height)'''
Get the original resolution of the video stream specified by the "num".
Parameters:
num: video stream number.
width(out): width of video.
height(out): height of video.

'''GetVideoAspectRatio(i: num, i(out): ratio_num, i(out): ratio_denum)'''
Get the original aspect ratio of the video stream specified by the "num".
Parameters:
num: video stream number.
ratio_num(out): numerator of the aspect ratio.
ratio_denum(out): denumerator of the aspect ratio.

'''GetProtocolName(s(out): protocol_name)'''
Get the tranport protocol name.
Parameters:
protocol_name(out): name of the protocol.

'''Record(b: to_record, s: location)'''
Start or stop the recording of current playing DVB stream.
Parameters:
to_record: True to start recording, False to stop recording.
location: path to store the record file.

'''GetPat(aa{sv}(out): pat)'''
Get the "Program Association Table".
Parameters:
pat(out): the "Program Association Table".
The structure of pat is a list of mapping table. Each mapping table has two key-value pairs:
Key Value
"program-number" value of "u" type which indicates the program number.
"pid": value of "u" type which indicates the pid of the pat.

'''GetPmt(u(out): program_number, u(out): pcr_pid, aa{sv}(out): stream_info)'''
Get the "Program Map Table" of current playing DVB program.
Parameters:
program_number(out): the number of current playing program.
pcr_pid(out): the pcr pid.
stream_info(out): the information of all elementary streams multiplexed in this program.
The structure of stream_info is a list of mapping table. Each mapping table has two key-value pairs:
Key Value
"stream-type" value of "u" type indicates the stream type.
"pid" value of "u" type indicates the pid of the elementary stream.

'''GetAssociatedDataChannel(s(out): ip, i(out): port)'''
Get the ip and port from which the client can retrive DVB associated data(ts packets).
Parameters:
ip(out): ip string
port(out): port string

Signals:
'''Initialized'''
Pipeline engine initialized.

'''Eof'''
End of file or stream.

'''Error(u: id, s: message)'''
Error happened.
Parameters:
id: error id.
message: error message.

'''Buffering(i: percent)'''
Buffering percent, from 0 to 100.

'''Seeked'''
Seeking done.

'''Stopped'''
Player stopped.

'''PlayerStateChanged(i: old_state, i: new_state)'''
Player state changed.
Parameters:
old_state: previous state of player, value definition is the same as state parameter of GetPlayerState.
new_state: current state of player, value definition is the same as state parameter of GetPlayerState.

'''NeedReply'''
Singal to request the client to reply. This is used for client existence checking. The client should call the Reply() method to response this
signal.

'''Suspended'''
The player has been suspended. That means all the resources ocuppied by this player has been released.

'''Restored'''
The player restored from suspened.

'''NoResource'''
Resource unavailable.

'''VideoTagChanged(i: video_number)'''
The metadata of a video stream changed.
Parameters:
video_number: video stream number.

'''AudioTagChanged(i: audio_number)'''
The metadata of a audio stream changed.
Parameters:
audio_number: audio stream number.

'''TextTagChanged(i: text_number)'''
The metadata of a text stream changed.
Parameters:
text_number: text stream number.

'''RecordStart'''
The recording started.

'''RecordStop'''
The recording stopped.

* '''''Interface: com.UMMS.AudioManger'''''

Methods:
'''SetVolume(i: output_type, i: volume)'''
Set the global audio volume on audio output specified by "output_type".
Parameters:
output_type: output type id.
0, hdmi
1, spidf
2, i2s0
3, i2s1
volume: volume to set, range [0, 100]

'''GetVolume(i: output_type, i(out): volume)'''
Set the global audio volume on audio output specified by "output_type".
Parameters:
output_type: output type id.
volume(out): current volume.

'''SetState(i: output_type, i: state)'''
Mute/Unmute the audio output.
Parameters:
output_type: output type id.
state: 0 to unmute, 1 to mute.

'''GetState(i: output_type, i(out): state)'''
Get the mute state of audio output.
Parameters:
output_type: output type id.
state(out): 0 for unmute, 1 for mute.

* '''''Interface: com.UMMS.VideoOutput'''''

Methods:
'''GetValidVideoOutput(as(out): outputs)'''
Get name of all the outputs.
Parameters:
outputs(out): output names.

'''GetValidMode(s:output_name, as(out): modes)'''
Get valid display modes of a output specified by output_name
Parameters:
output_name：output name.
modes(out): valid display modes.

'''SetMode(s:output_name, s: mode)'''
Set display mode of the output.
Parameters:
output_name：output name.
mode: mode to set.

'''GetMode(s:output_name, s(out): mode)'''
Get current display mode of the output.
Parameters:
output_name：output name.
mode(out): current display mode.

* '''''Interface: com.UMMS.PlayingContentMetadataViewer'''''

Methods:
'''GetPlayingContentMetadata(aa{sv}(out): playing_content_metadata)'''
Get the current playing content metadata.
Parameters:
playing_content_metadata(out): media content metadata
The structure of playing_content_metadata is a list of mapping table. Each mapping table has 3 key-value pairs:
Key Value
"URI" Value of "s" type indicates the current playing URI.
"Title" Value of "s" type indicates the title of the playing media content
"Artist" Value of "s" type indicates the artist of the playing media content

Signals:
'''MetadataUpdated(aa{sv}: metadata)'''
Emitted when a metadata changed. e.g. A new player is requested to play a video.
Parameters:
metadata: The same as playing_content_metadata

== Sample Code ==
This is a sample application written in Python to play a URI by requesting an attended-execution media player instance. You can get the latest code from: git://gitorious.org:meego-middleware/umms.git
<pre>
import dbus
import dbus.mainloop.glib
import dbus.glib

player_iface = None
loop = None

def need_reply_cb ():
player_iface.Reply()

def eof_cb ():
print "EOF...."
loop.quit()

#event loop
dbus.mainloop.glib.DBusGMainLoop(set_as_default=True)

#get the system message deamon
bus=dbus.SystemBus()

#get the 'com.UMMS.ObjectManager.iface'
bus_obj=bus.get_object('com.UMMS', '/com/UMMS/ObjectManager')
obj_mngr=dbus.Interface(bus_obj, 'com.UMMS.ObjectManager.iface')

#request a media player for attended-execution
player_obj_path = obj_mngr.RequestMediaPlayer()
player_obj = bus.get_object("com.UMMS", player_obj_path)
player_iface = dbus.Interface(player_obj, 'com.UMMS.MediaPlayer')

#for the attended-execution, we must connect to the "NeedReply" signal
player_iface.connect_to_signal("NeedReply", need_reply_cb)

#connect other signals you want
player_iface.connect_to_signal("Eof", eof_cb)

#play a URI
player_iface.SetUri("/tmp/sample.mp4")
player_iface.Play()

#event loop
loop = gobject.MainLoop()
loop.run()
</pre>

Umms

2013-02-05T13:31:32Z

Dominig: /* Universal Multimedia Service (UMMS) */

= Universal Multimedia Service (UMMS) =

1 Short description of the need
---------------------------------
Linux in general, including MeeGo in particular, lacks a unified solution for playing multimedia content. Almost every application has its own solution, limiting the opportunity to benefit from new hardware capabilities provided by modern chipsets on non-PC platforms, and reducing the scope of usability of high value multimedia content, which is often protected using a proprietary codec.
It isn't the first time that Linux has had to break boundaries and change established solutions to drastically improve its support for new services. In the recent past, we've seen the adoption of CUPS (1999-2002) for printing and Sane (2000-2005) for scanning, enabling the use of Linux in the office environment, which, before these two, seemed only possible for the geek in search of a long night enjoying troubleshooting fun.
The current proposition has no less of an outrageous ambition than creating a Unified Multi Media Service (UMMS), which will enable playing audio and video (AV) from an application on any Linux platform (starting from MeeGo), without having to worry about anything more than its position on the screen and its possible initial transparency over the User Interface graphics.
2 Purpose/audience
--------------------
The purpose of this document is to provide an understanding of a solution which could be used to deliver a unified service. This would enable a large community of developers to benefit from the best possible audio and video capabilities provided by various Linux implementations, without having to worry about the supporting HW.
It addresses the managers who wish to understand the requirements and the constraints required for such a solution, as well as the developers who will have to deliver a working implementation.
It focuses on an initial application for MeeGo TV, but it has been designed with the vision to expand, in a second phase, to all MeeGo verticals, starting with tablets. It is intended to go beyond TV and tablets and further, and experience a general adoption by the larger Linux community. Only MeeGo needs are described in this initial document.
3 Overview
------------
MeeGo is an open source version of Linux which targets Netbooks, Tablets, Mobiles, Connected TV, and Automotive domains. MeeGo has the goals of delivering an optimized user experience and also enabling a community of developers to service applications across domains.
Unfortunately, not only does Linux not have a standard set of APIs to play audio and video (AV), but the existing main Linux AV Player APIs (Mplayer and Totem) do not cater to TV's needs:
<ul>
<li>Programming language independence</li>
<li>Management of protected high value content (Pay TV)</li>
<li>GPL license isolation</li>
<li>Support of TV features (broadcast, sub-title, language selection, aspect ratio, trick play, …)</li>
<li>Sophisticated transport independence (smooth streaming, forward error correction, ...)</li>
<li>Multiple back-end video pipe support</li>
<li>Support of new generation HW feature (for example, video as an OpenGL texture)</li>
</ul>

This document explains the constraints introduced by these requirements and provides possible solutions and recommendations.

4 Documentation
----------------------------

Specifications [[File:Meego_Unified_MultiMedia_Service_V0.4.odt]] 
* [[UMMS_Architecture | General Architecture]] 
* [[UMMS_User_Manual | User Manual and Sample code]] 
* [[media:LinuxCon_2011_umms_introduction.pdf|Slides from Linux Conference Oct11 and Nov 11]]

Javascript API
* [[TV Browser]]

Mailing list is run on Tizen-general
https://lists.tizen.org/listinfo/general

5 Where is the code
-----------------
Visit MeeGo OBS and search for UMMS
https://build.meego.com

or directly the GIT repo
git://gitorious.org/meego-middleware/umms.git

UMMS User Manual

2013-01-24T09:39:08Z

Dominig: /* Introduction */

= UMMS User Manual and Sample code =

== Introduction ==
This page is the user manual and some sample code for the Universal Multi Media Service (UMMS). 
The UMMS general description is on the '''[[Umms|main page]]'''.
== Source code ==
You can get the code from:
git://gitorious.org/meego-middleware/umms.git

== Service Name ==
com.UMMS

== Objects and Interfaces ==
''ObjectManager'': Object to create and remove ''MediaPlayer'' object.
Path: /com/UMMS/ObjectManager
Interface: com.UMMS.ObjectManager.iface

''MediaPlayer'': Player object to control the playback of media assets.
Path: Returned by ''ObjectManager''
Interface: com.UMMS.MediaPlayer

''AudioManager'': Object to manage the system audio output.
Path: /com/UMMS/AudioManager
Interface: com.UMMS.AudioManger

''VideoOutput'': Object to control the display.
Path: /com/UMMS/VideoOutput
Interface: com.UMMS.VideoOutput

''PlayingContentMetadataViewer'': Object to provide the metadata of all currently playing content.
Path: /com/UMMS/PlayingContentMetadataViewer
Interface: com.UMMS.PlayingContentMetadataViewer

== API Reference ==
* '''''Interface com.UMMS.ObjectManager.iface'''''

Methods:

'''RequestMediaPlayer(s(out): object_path)'''
Request a ''MediaPlayer'' object operate in attended-execution mode. The ''ObjectManager'' will create a new ''MediaPlayer'' object,
register the object on the bus and return the object path to client.
Parameters:
object_path(out): The object path belongs to the newly created ''MediaPlayer'' object.

'''RequestMediaPlayerUnattended(d: time_to_execution, s(out): token, s(out): object_path)'''
Request a ''MediaPlayer'' object operate in unattended-execution mode. The ''ObjectManager'' will create a new ''MediaPlayer'' object,
register it on the bus and return the object path to client.
Parameters:
time_to_execution: Times in seconds for which this ''MediaPlayer'' object keep alive.
token(out): The unique token belongs to this execution. Application can use it to identify the execution log file which
named by the token.
object_path(out): The object path belongs to the newly created ''MediaPlayer'' object.

'''RequestScheduledRecorder(d: start_time, d: duration, s: uri, s: location, s(out): token, s(out): object_path)'''
Request a ''MediaPlayer'' object operate in unattended-execution mode and schedule it to record the media pointed by "uri". The ''ObjectManager'' will create a
new ''MediaPlayer'' object, register it on the bus and return the object path to client.
Parameters:
start_time: The delay to start recording in seconds.
duration: How long to record, in seconds.
uri: Specify the media to record.
location: Location to store the recorded media.
token(out): The unique token belongs to this execution. Application can use it to identify the execution log file which
named by the token.
object_path(out): The object path belongs to the newly created ''MediaPlayer'' object.

'''RemoveMediaPlayer(s: object_path)'''
Remove the ''MediaPlayer'' object which was exposed on the object_path.
Parameters:
object_path: The path on which this object was exposed.

* '''''Interface com.UMMS.MediaPlayer'''''

Methods:

'''SetUri(s: uri)'''
Set URI to UMMS.
Parameters:
uri: URI to set.

'''SetSubtitleUri(s: sub_uri)'''
Set subtitle URI to UMMS.
Parameters:
sub_uri: URI to identify the subtitle file.

'''GetCurrentUri(s(out): current_uri)'''
Get current URI.
Parameters:
current_uri(out): current URI.

'''SetTarget(i: type, a{sv}: param)'''
Set video target and pass all target parameters to UMMS. The video target is where your decoded video data should be rendered.
Parameters:
type: The type of video target.
0:XWindow, the video data will be rendered on the X Window.
1:DataCopy, the video data will be copied to a memory instead of directly rendering. E.g. copied to a GL Texture.
2:Socket, the video data will sent to a socket.
3:ReservedType0, reserved for custom target.
4:ReservedType1, reserved for custom target.
5:ReservedType2, reserved for custom target.
6:ReservedType3, reserved for custom target.
param: The list of key-value pair to specify the attributes of the target. The definition of attribute structure is
target-specific and up to the implementor. The UMMS framwork just defined the XWindow target attribute:
Key Value
"window-id" value of "i" type indicates the window id.

'''Play()'''

'''Pause()'''

'''Stop()'''

'''SetPosition(x: pos)'''
Seek to position.
Parameters:
pos: Stream position in millisecond.

'''GetPosition(x(out): pos)'''
Get the current position of stream in millisecond.
Parameters:
pos(out): The current stream position.

'''SetPlaybackRate(d: rate）'''
Set the playback rate.
Parameters:
rate: rate to playback the media asset.

'''GetPlaybackRate(d(out): rate）'''
Get current playback rate.
Parameters:
rate(out): The current playback rate.

'''SetVolume(i: volume)'''

'''GetVolume(i(out): volume)'''

'''SetVideoSize(u: x, u: y, u: w, u: h)'''
Set video dimension.
Paramters:
x: X coordinate of top-left.
y: Y coordinate of top-left.
w: Width of video rectangle.
h: Height of video rectangle.

'''GetVideoSize(u(out): w, u(out): h)'''
Get current width and height of video rectangle.
Parameters:
w(out): Width of current video rectangle.
h(out): Height of current video rectangle.

'''GetBufferedTime(x(out): length_time)'''
Get the approximate duration of playable data downloaded so far in millisecond.
Parameters:
length_time(out): amount of playable data downloaded so far in millisecond.

'''GetBufferedBytes(x(out): length_byte)'''
Get the approximate amount of playable data downloaded so far in bytes.
Parameters:
length_byte(out): amount of playable data downloaded so far in byte.

'''GetMediaSizeTime(x(out): duration)'''
Get the duration of the media.
Parameters:
duration(out): duration in millisecond.

'''GetMediaSizeBytes(x(out): size)'''
Get the total size of the media file.
Parameters:
size(out): total size of the media file.

'''HasVideo(b(out): has_video)'''
Indicates the existance of video stream in the media asset.
Parameters:
has_video(out): True if media asset has video. False otherwise.

'''HasAudio(b(out): has_audio)'''
Indicates the existance of audio stream in the media asset.
Parameters:
has_audio(out): True if media asset has audio. False otherwise.

'''IsStreaming(b(out): is_stream)'''
Indicates whether the URI represents a streaming media.
Parameters:
is_stream(out): True for streamimg media. False otherwise.

'''IsSeekable(b(out): is_seekable)'''
Indicates whether this media asset is seekable.
Parameters:
is_seekable(out): True for seekable. False otherwise.

'''SupportFullScreen(b(out): support_fullscreen)'''
Indicates whether the backend supports a fullscreen mode.
Parameters:
support_fullscreen(out): True if backend supports fullscreen. False otherwise.

'''GetPlayerState(i(out): current_state)'''
Get current state of ''MediaPlayer'' object.
Parameters:
current_state(out):
0:Null,
1:Stopped,
2:Paused,
3:Playing

'''Reply()'''
Response the UMMS server’s heartbeat check. In the attended-execution mode, client should connect to NeedReply
signal with a callback in which Reply() method should be called.

'''SetProxy(a{sv}: param)'''
Set proxy stuffs.
Parameters:
param: A list of key-value pair to sepcify the proxy attributes.
The attribute structure is defined as:
Key Value
"proxy-uri" value of "s" type indicates HTTP proxy server URIl
"proxy-id" value of "s" type indicates HTTP proxy user id for authentication.
"proxy-pw" value of "s" type indicates HTTP proxy user password for authentication

'''Suspend()'''
Suspend current execution of player. After this invoking, all the resources ocuppied by this session will be released.

'''Restore()'''
Play the media asset from the position at where it suspended.

'''GetCurrentVideo(i(out): current_video)'''
Get current playing video stream.
Parameters:
current_video(out): stream number of current playing video.

'''GetCurrentAudio(i(out): current_audio)'''
Get current playing audio stream.
Parameters:
current_audio(out): stream number of current playing audio.

'''GetCurrentSubtitle(i(out): current_sub)'''
Get current playing subtitle stream.
Parameters:
current_sub(out): stream number of current playing subtitle.

'''SetCurrentVideo(i: current_video)'''
Choose the video stream to play.
Parameters:
current_video: stream number of video stream choosed to play.

'''SetCurrentAudio(i: current_audio)'''
Choose the audio stream to play.
Parameters:
current_audio: stream number of audio stream choosed to play.

'''SetCurrentSubtitle(i: current_sub)'''
Choose the subtitle stream to play. This method is for the media asset with embedded subtitle.
Parameters:
current_sub: stream number of subtitle stream choosed to play.

'''GetVideoNum(i(out): video_num)'''
Get total number of video streams.
Parameters:
video_num(out): Total number of video streams.

'''GetAudioNum(i(out): audio_num)'''
Get total number of audio streams.
Parameters:
audio_num(out): Total number of audio streams.

'''SetBufferDepth(i: format, x: buf_depth)'''
Set buffer depth when buffering network streams.
Parameters:
format: 0 for Time, 1 for Btye.
buf_depth: The depth to buffer data.

'''GetBufferDepth(i: format, x(out): buf_depth)'''
Get buffer depth.
Parameters:
format: 0 for Time, 1 for Btye.
buf_depth(out): The depth to buffer data.

'''SetMute(i: is_mute)'''
Mute the audio.
Parameters:
is_mute: 0 for unmute, 1 for mute.

'''IsMute(i(out): is_mute)'''
Get the mute state.
Parameters:
is_mute(out): 0 for unmute, 1 for mute.

'''SetScaleMode(i: mode)'''
Set the scale mode.
Parameters:
mode:
0: do not scale.
1: fill entire target, regardless of original video aspect ratio.
2: scale the video with respect to original video aspect ratio.
3: fill the whole screen but keep the ratio, some part of video may out of screen.

'''GetScaleMode(i(out): mode)'''
Get the scale mode.
Parameters:
mode(out):
0: do not scale.
1: fill entire target, regardless of original video aspect ratio.
2: scale the video with respect to original video aspect ratio.
3: fill the whole screen but keep the ratio, some part of video may out of screen.

'''GetVideoCodec(i: num, s(out): video_codec)'''
Get the codec of video stream specified by the "num".
Parameters:
num: video stream number.
video_codec(out): codec string.

'''GetAudioCodec(i: num, s(out): audio_codec)'''
Get the codec of audio stream specified by the "num".
Parameters:
num: audio stream number.
audio_codec(out): codec string.

'''GetVideoBitrate(i: num, i(out): video_bitrate)'''
Get the bitrate of video stream specified by the "num".
Parameters:
num: video stream number.
video_bitrate(out): bitrate of the video stream.

'''GetAudioBitrate(i: channel, i(out): audio_bitrate)'''
Get the bitrate of audio stream specified by the "num".
Parameters:
num: audio stream number.
audio_bitrate(out): bitrate of the audio stream.

'''GetEncapsulation(s(out): encapsulation)'''
Get the container format.
Parameters:
encapsulation(out): the container format.

'''GetAudioSampleRate(i: num, i(out): sample_rate)'''
Get the sample rate of audio stream specified by the "num".
Parameters:
num: audio stream number.
sample_rate(out): sample rate of the audio stream.

'''GetVideoFrameRate(i: num, i(out): frame_rate_num, i(out): frame_rate_denum)'''
Get the frame rate of video stream specified by the "num".
Parameters:
num: video stream number.
frame_rate_num(out): numerator of frame rate.
frame_rate_denum(out): denumerator of frame rate.

'''GetVideoResolution(i: num, i(out): width, i(out): height)'''
Get the original resolution of the video stream specified by the "num".
Parameters:
num: video stream number.
width(out): width of video.
height(out): height of video.

'''GetVideoAspectRatio(i: num, i(out): ratio_num, i(out): ratio_denum)'''
Get the original aspect ratio of the video stream specified by the "num".
Parameters:
num: video stream number.
ratio_num(out): numerator of the aspect ratio.
ratio_denum(out): denumerator of the aspect ratio.

'''GetProtocolName(s(out): protocol_name)'''
Get the tranport protocol name.
Parameters:
protocol_name(out): name of the protocol.

'''Record(b: to_record, s: location)'''
Start or stop the recording of current playing DVB stream.
Parameters:
to_record: True to start recording, False to stop recording.
location: path to store the record file.

'''GetPat(aa{sv}(out): pat)'''
Get the "Program Association Table".
Parameters:
pat(out): the "Program Association Table".
The structure of pat is a list of mapping table. Each mapping table has two key-value pairs:
Key Value
"program-number" value of "u" type which indicates the program number.
"pid": value of "u" type which indicates the pid of the pat.

'''GetPmt(u(out): program_number, u(out): pcr_pid, aa{sv}(out): stream_info)'''
Get the "Program Map Table" of current playing DVB program.
Parameters:
program_number(out): the number of current playing program.
pcr_pid(out): the pcr pid.
stream_info(out): the information of all elementary streams multiplexed in this program.
The structure of stream_info is a list of mapping table. Each mapping table has two key-value pairs:
Key Value
"stream-type" value of "u" type indicates the stream type.
"pid" value of "u" type indicates the pid of the elementary stream.

'''GetAssociatedDataChannel(s(out): ip, i(out): port)'''
Get the ip and port from which the client can retrive DVB associated data(ts packets).
Parameters:
ip(out): ip string
port(out): port string

Signals:
'''Initialized'''
Pipeline engine initialized.

'''Eof'''
End of file or stream.

'''Error(u: id, s: message)'''
Error happened.
Parameters:
id: error id.
message: error message.

'''Buffering(i: percent)'''
Buffering percent, from 0 to 100.

'''Seeked'''
Seeking done.

'''Stopped'''
Player stopped.

'''PlayerStateChanged(i: old_state, i: new_state)'''
Player state changed.
Parameters:
old_state: previous state of player, value definition is the same as state parameter of GetPlayerState.
new_state: current state of player, value definition is the same as state parameter of GetPlayerState.

'''NeedReply'''
Singal to request the client to reply. This is used for client existence checking. The client should call the Reply() method to response this
signal.

'''Suspended'''
The player has been suspended. That means all the resources ocuppied by this player has been released.

'''Restored'''
The player restored from suspened.

'''NoResource'''
Resource unavailable.

'''VideoTagChanged(i: video_number)'''
The metadata of a video stream changed.
Parameters:
video_number: video stream number.

'''AudioTagChanged(i: audio_number)'''
The metadata of a audio stream changed.
Parameters:
audio_number: audio stream number.

'''TextTagChanged(i: text_number)'''
The metadata of a text stream changed.
Parameters:
text_number: text stream number.

'''RecordStart'''
The recording started.

'''RecordStop'''
The recording stopped.

* '''''Interface: com.UMMS.AudioManger'''''

Methods:
'''SetVolume(i: output_type, i: volume)'''
Set the global audio volume on audio output specified by "output_type".
Parameters:
output_type: output type id.
0, hdmi
1, spidf
2, i2s0
3, i2s1
volume: volume to set, range [0, 100]

'''GetVolume(i: output_type, i(out): volume)'''
Set the global audio volume on audio output specified by "output_type".
Parameters:
output_type: output type id.
volume(out): current volume.

'''SetState(i: output_type, i: state)'''
Mute/Unmute the audio output.
Parameters:
output_type: output type id.
state: 0 to unmute, 1 to mute.

'''GetState(i: output_type, i(out): state)'''
Get the mute state of audio output.
Parameters:
output_type: output type id.
state(out): 0 for unmute, 1 for mute.

* '''''Interface: com.UMMS.VideoOutput'''''

Methods:
'''GetValidVideoOutput(as(out): outputs)'''
Get name of all the outputs.
Parameters:
outputs(out): output names.

'''GetValidMode(s:output_name, as(out): modes)'''
Get valid display modes of a output specified by output_name
Parameters:
output_name：output name.
modes(out): valid display modes.

'''SetMode(s:output_name, s: mode)'''
Set display mode of the output.
Parameters:
output_name：output name.
mode: mode to set.

'''GetMode(s:output_name, s(out): mode)'''
Get current display mode of the output.
Parameters:
output_name：output name.
mode(out): current display mode.

* '''''Interface: com.UMMS.PlayingContentMetadataViewer'''''

Methods:
'''GetPlayingContentMetadata(aa{sv}(out): playing_content_metadata)'''
Get the current playing content metadata.
Parameters:
playing_content_metadata(out): media content metadata
The structure of playing_content_metadata is a list of mapping table. Each mapping table has 3 key-value pairs:
Key Value
"URI" Value of "s" type indicates the current playing URI.
"Title" Value of "s" type indicates the title of the playing media content
"Artist" Value of "s" type indicates the artist of the playing media content

Signals:
'''MetadataUpdated(aa{sv}: metadata)'''
Emitted when a metadata changed. e.g. A new player is requested to play a video.
Parameters:
metadata: The same as playing_content_metadata

== Sample Code ==
This is a sample application written in Python to play a URI by requesting an attended-execution media player instance. You can get the latest code from: git://gitorious.org:meego-middleware/umms.git
<pre>
import dbus
import dbus.mainloop.glib
import dbus.glib

player_iface = None
loop = None

def need_reply_cb ():
player_iface.Reply()

def eof_cb ():
print "EOF...."
loop.quit()

#event loop
dbus.mainloop.glib.DBusGMainLoop(set_as_default=True)

#get the system message deamon
bus=dbus.SystemBus()

#get the 'com.UMMS.ObjectManager.iface'
bus_obj=bus.get_object('com.UMMS', '/com/UMMS/ObjectManager')
obj_mngr=dbus.Interface(bus_obj, 'com.UMMS.ObjectManager.iface')

#request a media player for attended-execution
player_obj_path = obj_mngr.RequestMediaPlayer()
player_obj = bus.get_object("com.UMMS", player_obj_path)
player_iface = dbus.Interface(player_obj, 'com.UMMS.MediaPlayer')

#for the attended-execution, we must connect to the "NeedReply" signal
player_iface.connect_to_signal("NeedReply", need_reply_cb)

#connect other signals you want
player_iface.connect_to_signal("Eof", eof_cb)

#play a URI
player_iface.SetUri("/tmp/sample.mp4")
player_iface.Play()

#event loop
loop = gobject.MainLoop()
loop.run()
</pre>

Tizen IVI

2012-05-23T21:30:48Z

Dominig: /* Start OBS Light GUI */

== Creation of a Tizen IVI with OBS Light ==
Note this page needs to be moved to Tizen Wiki and image snapshot addition.
=== Install OBS Light ===
Select you installation depending of your PC OS.
[[OBS Light Installation]]
=== Download a valid Kick Start file ===
Check which release you want to build an image with.
Note that new build repo are available every day but they may not be operational.
See : http://download.tizen.org/previews/ivi/

Recover a .ks file. The following can be used as example.
http://download.tizen.org/previews/ivi/tizen_20120410.10/images/ivi-min-pc/ivi-min-pc-tizen_20120410.10.ks

=== Start OBS Light GUI ===
We will not configure any OBS as we are only interested in image creation.

[[File:OBSLightMIC.png]]

* To activate the mode MIC, Click on the second Tab on Top left of the screen
* Create a new project with the button 'New' on the bottom left of the screen
* Import the .ks file using the button 'Import Kickstart file'
* Select your image type (default is fs for file system)
* You can check the various option by clicking on the various tab.
* Click 'Create Image'
* Click 'Show Log' -> Wait about 10mn - once that the cache is created it's quicker

If your .ks file is valid you will have an image located in your project directory.
OBS Light integrates an option to export of that image via TFTP/NFS for quick test.

Change your config and play with the .ks option as much as desired.

Enjoy.

File:OBSLightMIC.png

2012-05-23T21:30:03Z

Dominig: OBS Light Image creation GUI

OBS Light Image creation GUI

Tizen IVI

2012-05-23T21:25:41Z

Dominig: c

== Creation of a Tizen IVI with OBS Light ==
Note this page needs to be moved to Tizen Wiki and image snapshot addition.
=== Install OBS Light ===
Select you installation depending of your PC OS.
[[OBS Light Installation]]
=== Download a valid Kick Start file ===
Check which release you want to build an image with.
Note that new build repo are available every day but they may not be operational.
See : http://download.tizen.org/previews/ivi/

Recover a .ks file. The following can be used as example.
http://download.tizen.org/previews/ivi/tizen_20120410.10/images/ivi-min-pc/ivi-min-pc-tizen_20120410.10.ks

=== Start OBS Light GUI ===
We will not configure any OBS as we are only interested in image creation.

* To activate the mode MIC, Click on the second Tab on Top left of the screen
* Create a new project with the button 'New' on the bottom left of the screen
* Import the .ks file using the button 'Import Kickstart file'
* Select your image type (default is fs for file system)
* You can check the various option by clicking on the various tab.
* Click 'Create Image'
* Click 'Show Log' -> Wait about 10mn - once that the cache is created it's quicker

If your .ks file is valid you will have an image located in your project directory.
OBS Light integrates an option to export of that image via TFTP/NFS for quick test.

Change your config and play with the .ks option as much as desired.

Enjoy.

OBS Light

2012-05-23T21:08:29Z

Dominig: /* Why should I use OBS Light ? */

[[File:OBSLightWiki.png‎ ]]
[http://blynt.canalblog.com/ Blynt]

= Why should I use OBS Light ?=
* I want to create a [https://meego.com/ MeeGo-based] distribution for my target ([https://meego.com/devices/smart-tv Smart TV], [https://meego.com/devices/in-vehicle In-Vehicle], [https://meego.com/devices/media-phone Media phone], [https://meego.com/devices/netbook Netbook], [https://meego.com/devices/handset Handset] ...).
* I want to create an image for [[Tizen IVI | Tizen IVI Image Creation]]
* I want to include private code into my [https://meego.com/ MeeGo-based] distribution.
* I want to be fast from the beginning of my project to the first boot of my target.
* I want to use the same tools throughout my development cycle.

= Why not use OBS Light ?=
OBS Light is targeting the development of variants of MeeGo distribution (or any OBS build distro) to either add extra features to a MeeGo product or adapt a MeeGo distribution to different hardware configurations.
It is not an another SDK, if you want to develop applications for a MeeGo product you should have a look at the [https://meego.com/developers MeeGo SDK] which likely will better fit your need.

= What is OBS Light ?=
The project 'OBS Light' (or also obslight) , creates an encapsulation of OBS which presents a lighter face of OBS that we have called OBS light which could be delivered (if desired) with a pre-packaged MeeGo TV stack (or any other MeeGo vertical) released on a DVD image. The name was chosen to express that it remains an OBS base development process, but which is lighter to use, the idea of seeing the project as a light to guide the user in the flow of tools such as OBS, OSC, MIC, ... only came later. Once you will also see it incorrectly spell as 'OBS Lite'.

If you have (or are thinking about) selecting MeeGo but you cannot put all the code you want to build on OBS, the public, cloud-based MeeGo building tool, or if you are more comfortable with the tradition of local build tools based on a chroot than with a full cloud-based system like OBS, you might find the learning curve a bit steep.

While OBS will provide you with a very powerful and adapted tool for your long-term needs, the entry cost can be perceived to be too high.
This issue is particularly strongly perceived in the TV or IVI segments where recompilation of the Linux kernel and adding drivers is required even during the very early phases of a project and compiling in the public domain is out of the question.

In a second phase we hope to add a simple UI to it. It reuses the osc command line tools delivered with OBS to which a set of extra plugins have been added, including an extension of mic. All this remains compatible with a full implementation of OBS. It will be published under License: GPLv2.

The osc plugin for automatic patch creation are designed to be reusable in a full OBS environment.

The coding is under work and changes are likely to occur during the development process.

Note that under the hood, OBS light still is 100% OBS code and the building process is the same as what you could achieve by running your own private OBS.
OBS Light mainly pre-configures an OBS with a few osc plugins to ease the learning curve.

Note that some OBS feature are hidden to simplify the learning phase. As the service is run locally, you can mix Open Source and private code should you need to do so.

= Where to Download OBS Light? =

OBS Light is available either as a ready to run appliance to execute as a virtual machine, ready made packages for common distros and obsviously as source file to build it by yourself.

* [http://susestudio.com/a/e0uuBG/meego-obs-light OBS Light appliance], built thanks to Suse studio

* '''[[OBS Light Installation | Up-to-date Builds]]''' for various Linux Distros.

* Videos training and intro [http://www.dailymotion.com/playlist/x1t5ll_dominigarfoll_obs-light-training Starting with OBS Light]

= Where is the information about OBS Light? =
* [[OBS_Light_Manual | OBS Light manual]]
* [[OBS_Light_FAQ | Frequently Asked Questions]]
* You can file bugs on [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light MeeGo's bugzilla]. The bug list for the project can be reached [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light here]. To easily file a new bug, use [https://bugs.meego.com/enter_bug.cgi?product=Development%20Tools this link]

All discussions are run on the MeeGo-distribution-tools mailing list.
http://lists.meego.com/listinfo/meego-distribution-tools

= Where can I find a private OBS appliance? =
You can find a OBS appliance, build in [http://susestudio.com suse studio]:
http://susegallery.com/a/e0uuBG/meego-obs

For more information about private OBS: http://en.opensuse.org/openSUSE:Build_Service_private_instance

You can Download the boot strap of Meego 1.2.0 here (saveOBS.tar.aa -> saveOBS.tar.ba).
http://www.cc-e.co.uk/Meego/MeeGo-1.2.0/
reassembled the file
cat saveOBS.tar.?? >> saveOBS.tar.gz
Thanks to Julien Snell and Cocom for the ftp server.
http://www.cc-e.co.uk

= What difference between OBS and OBS Light? =
OBS Light use an OBS server.
{|
| || '''OBS Light''' || '''Full OBS'''
|-
| Cross compilation || Yes || Yes
|-
| Local and remote reference || Yes || Yes
|-
| Automatic creation of patch || Yes || Not Yet (will if the same osc plugin is loaded)
|-
| Bootable Image creation || Yes || Add on
|-
| Integrated version control || Hidden || Yes
|-
| Multi-user || Hidden || Yes
|-
| Multi-target by project || Hidden || Yes
|-
| Auto built || Hidden || Yes
|-
| Signing service || Hidden || Yes
|}

Initial Specifications (final implementation have differed from the initial concept) :[[https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/Doc/SpecOBSLight-1_V-0-6.pdf SpecOBSLight-1_V-0-6]]

= Where is the OBS Light code? =
GIT: https://meego.gitorious.org/meego-developer-tools/obs-light

OBS: https://build.pub.meego.com/project/show?project=Project%3AOBS_Light

OBS Light Manual

2012-05-08T22:02:13Z

Dominig: /* Videos training */

This is the user manual of the command-line and graphical interface of OBS Light.
* [[OBS_Light | OBS Light project]]
* [[OBS_Light_FAQ | Frequently Asked Questions]]
* [[ObsLightDeliverable | Installation]]
= General principles =
== Operation modes ==
OBS Light is available via command line (obslight) and a graphical user interface GUI (obslightgui).
Independently of that fact that you are using the command line or the GUI, you will get access to the same services.

== Videos training ==
We have created a set of video which will provide you a quick overview of how to start with OBS Light. 
They cover :
* Where to find the tool and information
* How to install OBS Light and get write access to an OBS
* Creation of you first project and package import
* Working in the project filesystem
* Auto creation of patch and upload to OBS

http://www.dailymotion.com/playlist/x1t5ll_dominigarfoll_obs-light-training

== Introduction Slides ==
Presentation done during the Tizen's Developers conference in San Francisco, CA, USA on May 7th, 2012 
[[File:Tizen OBS-Light-V2.1.pdf]]

== Step by step ==
=== Get Login access to an OBS server ===
OBS Light is a simplified model to develop code via an OBS. It does not replace your OBS.

To use OBS Light you will need a login access to an OBS. You have two simple methods to get a login on an OBS:
* You can create a login on several "free" OBS :
** MeeGo Community https://build.pub.meego.com/
** OpenSUSE https://build.opensuse.org/
* Run your private OBS instance
** Select a ready made MeeGo OBS appliance (highly recommended) http://susestudio.com/a/e0uuBG/meego-obs
** Install your private full appliance (advanced users only) http://en.opensuse.org/openSUSE:Build_Service_private_instance

Once you have a login on an OBS instance, you will need to copy a project to play with. You can use the utilities ''obstag'' and ''obs2obscopy'' to achieve that in an easy way. See [[ Obstag ]].

=== Configure your OBS servers ===
OBS Light needs to know on which server you will connect to. As OBS Light does more than the osc tool, more information will be needed. You will be asked the following :
* OBS server web URL
* OBS server API URL
* OBS repository URL
* Login
* Password
* Alias (note that Alias will need to be different from any Alias already present in your osc configuration and OBS light will enforce that constrain). If you plan to use the import/export functions make sure that you use the same Alias on the sending and receiving hosts.

Even if these information are copied in ''.osrcrc'', they must be maintain via the OBS light command.

=== Import the package(s) to work on ===
After the configuration of one or more OBS servers, you will be able to import a package to work on.
You can also create an empty package would you like to.

OBS Light will create a local copy of that package on your workstation in a very similar way to what an osc checkout action would do.
As osc, OBS Light transparently keeps track directly of the links between the packages and the associated OBS servers.

=== Create the project filesystem ===
Once that you have loaded the packages, you can request the creation of a "chroot jail" (thereafter referred to as "filesystem" or "project filesystem"), where the packages can be built without interfering with the host's filesystem. The created filesystem is specific to the project and will not be recreated if it's already present.
During the creation of the filesystem, extra packages imposed by the build dependencies will be loaded automatically. If you are connected on a remote OBS that phase can take some time and may require a bit of patience.

OBS Light tries to load automatically the dependencies from the analysis of the .spec file in the RPM but that is not always possible. The user has the possibility to add manually extra file and/or packages to the filesystem.

Packages can be imported either from a project already present in OBS Light or from any URL.

=== Importing the code in the project filesystem ===
Once that the filesystem is created, the source from the package can be imported in the filesystem. During that process, OBS Light will load the extra package needed to build that specific imported source and will create a special git tree which will monitor any changes done by the user.

The user can directly open a window on the filesystem from OBS Light. The console program used by default can be defined in the OBS Light configuration file.
From there direct modification of the code in the filesystem is possible and local build can be run as often as desired.

=== Committing changes ===
When the user is happy of his change, he can request the change from the filesystem to be committed directly in the package.

A patch will be created and added to the package and configured in the .spec file by OBS Light.

=== Saving changes on the OBS server ===
Once that changes on a given project (which can work on one or multiple packages) achieve a stage which is worth to push on the OBS server. The user can simply request to save the project and OBS Light will commit the changes automatically.

== Example: patching MeeGo 1.2 ''kernel'' package ==

=== Step1: inform ''obslight'' about your OBS account ===
## synthax: obslight server add server_alias <server_alias> login <login> password <password> api_url <api_url> repository_url <repository_url> web_url <web_url>
;''server_alias''
: is the alias you want to use to refer to this server.
;''api_url''
: is the URL to the OBS control API. If you are using [http://susestudio.com/a/e0uuBG/meego-obs OBS appliance], it's probably on port 81.
;''repository_url''
: is the URL to the OBS package repositories. If you are using [http://susestudio.com/a/e0uuBG/meego-obs OBS appliance], it's probably on port 82.
;''web_url''
: is the URL to the OBS web interface.

=== Step2: create a local project related to your OBS project ===
* The project is created in '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/'''
## synthax: obslight obsproject add <project_alias> <name_on_obs> <target> <arch> <server_alias>
obslight obsproject add MeeGo_1.2_oss MeeGo:1.2:oss standard i586 <server_alias>
;''project_alias''
: is the name you will use to refer to this project with the ''obslight'' command (e.g. ''MeeGo_1.2_oss'').
;''name_on_obs''
: is the name of the project on the OBS (e.g. ''MeeGo:1.2:oss'').
;''target''
: is the target against which we will build (''standard'' is the common name when there is only one).
;''arch''
: is the target architecture of the project.
;''server_alias''
: is the alias of the OBS server from which we get the project (which has been configured in first step).

=== Step3: add the kernel package to your local project ===
* The package is created in '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/MeeGo:1.2:oss/kernel/'''
* In this directory, the package is manageable by osc.
## synthax: obslight package add package <package> project_alias <project_alias>
obslight package add package kernel project_alias MeeGo_1.2_oss
;''package''
: is the name of the package you want to work on (e.g. '''kernel''').
;''project_alias''
: is the name of the project you created in step2.

=== Step4: create the filesystem of the project ===
* The filesystem root directory is '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/aChroot/'''.
* zypper is included in the filesystem and your OBS project's repository is automatically added.
## synthax: obslight filesystem create <project_alias>
obslight filesystem create MeeGo_1.2_oss

=== Step5: add the source of the kernel package into your filesystem ===
* The source package is extracted in directory '''/root/rpmbuild/BUILD/kernel-X.X.X/linux-X.X.X'''.
* After the installation, a git repository is initialized in package's directory.
## synthax: obslight rpmbuild prepare package <package> project_alias <project_alias>
obslight rpmbuild prepare package kernel project_alias MeeGo_1.2_oss

=== Step6: work as you want into your filesystem ===
* The directory '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/chrootTransfert/''' is mounted into the chroot jail in '''/chrootTransfert/'''.
* Every script executed in ''aChroot'', is stored in '''/chrootTransfert/''' as '''runMe_YYYY-MM-DD_HHhMMmSS.sh'''.
## synthax: obslight filesystem enter package <package> project_alias <project_alias>
obslight filesystem enter package kernel project_alias MeeGo_1.2_oss

Now you are logged in the chroot jail.
In this example we just modify the kernel configuration.
$ cp configs/kernel-x86.config .config
$ make menuconfig

=== Step7: save your modifications ===
There are two methods.

==== Method1: by making a patch ====
$ cp .config config-x86
$ exit

## synthax: obslight rpmbuild createpatch <patch> package <package> project_alias <project_alias>
obslight rpmbuild createpatch myKernelPatch.patch package kernel project_alias MeeGo_1.2_oss

* The patch is automatically added to the local spec file.
* '''myKernelPatch.patch''' is automatically added to the local package directory.
* ''kernel package specific:'' you must move the patch application command '''%patchXXX -p1''' after the command line '''cp $RPM_SOURCE_DIR/config-* .''' in the local spec file
vi ~/OBSLight/MeeGo_1.2_oss/MeeGo:1.2:oss/kernel/kernel.spec

==== Method2: by copying the new configuration file in OSC directory ====
$ cp .config /chrootTransfert/config-x86
$ exit
cp ~/OBSLight/ObsProjects/MeeGo_1.2_oss/chrootTransfert/config-x86 ~/OBSLight/ObsProjects/MeeGo_1.2_oss/MeeGo:1.2:oss/kernel/

=== Step8: Upstream your modifications to the OBS server ===
* The command ''package commit'' checks the additions and deletions of files, before committing the package to the OBS server.
## synthax: obslight package commit <message> package <package> project_alias <project_alias>
obslight package commit "Patch kernel" package kernel project_alias MeeGo_1.2_oss

= Command-line =

The help is integrated in the tool. ''obslight help'' will give you an online help.

To get more detail on a specific command you can type ''obslight <command> help''.

$ obslight help
OBSlight:
Provides a tool to manage an OBS project on your local machine in command line
For informations, see the Help section
obslight --Help
The gui for OBSlight is obslightgui
A FAQ is available at:
*http://wiki.meego.com/OBS_Light_FAQ
For additional informations, see:
*http://wiki.meego.com/OBS_Light
Usage: OBSlight [global command] <command> [--command-options]

Type OBSlight <command> --Help to get Help on a specific command.
Commands:

server: Manage the OBS server
obsproject: Manage the OBSlight project
package: Manage the packages of OBSlight project
projectfilesystem (projectfs,filesystem,pfs) :
Manage the project filesystem of OBSlight project
rpmbuild (rb) : Manage the rpmbuild of the package into the project filesystem
man: print the man help document

global Options:

quiet (-quiet,--quiet) : run obslight in quiet mode
debug (-debug,--debug) : run obslight in debugger mode
version (--version) : show program's version number and exit
help (-h,-help,--help) : show this help message and exit
noaction: Execute command but do nothing

= Graphical interface =
The GUI is launched via the command ''obslightgui''.
Only the parameter ''--version'' is supported.

It has two main tabs: one for OBS projects, one for MIC projects

The buttons in each section apply to the relative section. They display a tool-tip when the mouse is positioned on them.
Button are grayed when there are not active or not yet implemented.

== OBS projects tab ==
[[File: Obslightgui_01.png|600px|OBS Light GUI main window]]

This tab allows you to manage an OBS project, its packages (and their files) and its filesystem.

It has 3 main areas:
* OBS project
* Packages
* local files and project filesystem (on a tab)

=== The project panel ===
The panel on the left displays the list of OBS projects locally configured, and information about the selected project.

{| border="1" cellpadding="5"
|
;New
: Create a new project. Currently you cannot create a new project from scratch using OBS Light, only import one.
;Import
: Import a project from an OBS server.
;Delete
: Delete the selected project. The project will be removed locally but will remain on the OBS server.
;Modify
: Modify the selected project configuration.
|
;Save
: Save the selected project to a file.
;Load
: Load a project from a file.
|}

=== The package panel ===
The panel on the middle displays the list of packages of the selected project, and information about the selected package.

{| border="1" cellpadding="5"
|
;New
: Create a new package. Currently you cannot create a new package from scratch using OBS Light, only import one.
;Import
: Import a package from an OBS project.
;Delete
: Delete the selected package(s). The packages will be removed locally but will remain on the OBS server.
;Modify
: Modify the package title and description. Currently not available.
|
;Update files
: Checkout/update files from the OBS (''osc update'' equivalent).
;Commit changes
: Commit changes to the OBS (''osc commit'' equivalent).
;Repair OSC directory
: Repair the OSC working copy of a package.
|
;Refresh status
: Refresh OBS and Local statuses.
|}

=== The file panel ===
The file panel has two tabs: '''Local directory''' and '''Project filesystem'''.

==== The local directory tab ====
This tab shows the list of files contained in the selected package.
{| border="1" cellpadding="5"
|colspan="2"|
;Open terminal
: Open a terminal in the package directory
;Package path
: Location of the package's OSC working copy
|-
| File-related buttons
| Patch-related buttons
|-
|
;New
: Create a new empty file. Currently not available.
;Import
: Add a file from your local filesystem to the package.
;Delete
: Delete the selected file from the package.
;Modify
: Launch an editor on the selected file.
|
;New
: Generate a patch from the changes made into the project filesystem, and add this patch to the package and in the yaml and/or spec files. This patch becomes the current patch of the package, until the next '%prep'.
;Import
: Import an external patch. Currently not available.
;Delete
: Delete a patch. Currently not available.
;Update
: Update the current patch with new modifications.
|}

==== The project filesystem tab ====
This tab shows the complete file tree of selected project's filesystem.
If a package is selected and it has previously been imported into the filesystem, its path is expanded by default.
{| border="1" cellpadding="5"
|colspan="3"|
;Open terminal
: Open a terminal in the filesystem, using '''chroot''', in the source directory of the current package if it is installed.
;Chroot path
: Location of the project filesystem.
|-
| Repository-related buttons
| Filesystem-related buttons
| Rpmbuild-related buttons
|-
|
;New
: Make a package repository accessible from zypper inside the filesystem, by URL.
;Import
: Make the package repository of another OBS Light project accessible from zypper inside the filesystem.
;Delete
: Delete a repository from the filesystem.
;Modify
: Modify the URL or alias of a repository.
|
;New
: Create the filesystem of the project.
;Import
: Not yet implemented.
;Delete
: Delete the filesystem
;Modify
: Not yet implemented.
|
;%prep
: Install the sources of a package into the filesystem, execute the %prep section of the spec file and do the first build.
;%build
: Execute the %build section of the spec file of the selected package, in an alternative rpmbuild directory.
;%install
: Execute the %install section of the spec file of the selected package, in an alternative rpmbuild directory.
;%files
: Build the source and binary RPMs of the selected package, in an alternative rpmbuild directory.
|}

== MIC projects tab ==
This tab allows you to manage a MIC (MeeGo Image Creator) project. You can change its architecture and image type, and edit its Kickstart file.

On the left panel you can see a list of MIC projects. Click ''New'' to add one, you will be asked for a name, and an empty Kickstart file will be created.

=== Project options ===
[[File: Obslightgui_mic_01.png|600px|OBS Light GUI main window - MIC project - Project options]]

In this tab you can:
* change the generated image type
** ''fs'': a directory hierarchy containing the whole filesystem
** ''livecd'': a bootable image suitable for a CD
** ''liveusb'': a bootable image suitable for a USB key
** ''loop'': a filesystem image to be mounted with a loop device (with ''mount -o loop'')
** ''raw''
* change the architecture of the project (only i686 has been tested)
* open the directory of the project (with you default file browser)
* import a Kickstart file (that will overwrite the current file)
* export the current Kickstart file
* launch the creation of the image

=== Kickstart options ===
[[File: Obslightgui_mic_02.png|600px|OBS Light GUI main window - MIC project - Kickstart options]]

In this tab you can add, delete or modify the different options of the project's Kickstart file. These options are documented [http://fedoraproject.org/wiki/Anaconda/Kickstart here].

* To add an option press the ''add'' button, and enter the full option line in the bottom text field, then press ''save''.
* To modify an option, select it, modify the bottom text field and press ''save''.
* To delete an option, select it, press ''delete'', and then ''save''.

Notice that some options may have aliases, which will appear on the same line in the option list.
The ''repo'' option will not be listed here, but in the [[OBS_Light_Manual#Repositories | Repositories]] tab.

=== Repositories ===
[[File: Obslightgui_mic_03.png|600px|OBS Light GUI main window - MIC project - Kickstart repositories]]

In this tab, you can add, delete, or modify Kickstart repositories.

* To add a repository, there are two possibilities:
** The repository is from an OBS project you worked on with OBS Light: press ''Import from OBS project'' and select the project.
** The repository is from an external project: press ''Add by URL'', and you will be asked for an URL and a name.
* To delete a repository, select it and press ''Delete''.
* To edit a repository, double-click on the cell of the property you want to edit (or simple click if it is a checkbox).
The changes are automatically saved.

=== Packages ===
[[File: Obslightgui_mic_04.png|600px|OBS Light GUI main window - MIC project - Kickstart packages]]

Here you can edit the package list of the project's Kickstart file.
Notice that multiple ''%package'' sections of original Kickstart file have been merged into one.

Each package has an ''Included'' parameter which tells if it should be included in the generated image. If ''Included'' is not checked, the package will be explicitly excluded in the Kickstart file (its name will be prefixed with '-').

=== Package groups ===
Here you can edit the list of package groups of the project's Kickstart file.
At the moment, no verification is done on package groups.

=== Scripts ===
[[File: Obslightgui_mic_06.png|600px|OBS Light GUI main window - MIC project - Kickstart scripts]]

Here you can add, delete or modify Kickstart scripts.

* To add a script, press ''Add'', write your script in the bottom text field, choose script options in the right panel, and press ''Save''.
* To delete a script, select it and press ''Delete''.
* To modify a script, select it, modify the script in the bottom text field or the script options in the right panel, and press ''Save''.

=== Overlay files ===
[[File: Obslightgui_mic_07.png|600px|OBS Light GUI main window - MIC project - Overlay files]]

Here you can add files that will be included in the project image.
* To add an overlay file, press ''Add'' and a file browser will appear. Browse to your file and validate. Then a text dialog will appear, enter the path were you want your file to be copied in the image. '''tar''' archives will be extracted at the location you selected, instead of simply being copied.
* To delete an overlay file, select it and press ''Delete''.

Implementation details:
* source files are first copied in MIC project's directory
* each overlay file will appear as a ''%post --nochoot'' script in the Kickstart file (but will be hidden in the ''Scripts'' tab).

= Troubleshooting =

== <tt>"Source package 'xxx' not found"</tt> or <tt>"Problem: nothing provides X needed by Y"</tt> ==
These message may appear in two situations:
* The package you are trying to build is missing a dependency. OBS Light is not capable of searching dependencies outside the project from which your package comes. You will need to configure an additional repository in the project filesystem, using command ''filesystem repositories add'' or [[OBS_Light_Manual#The_project_filesystem_tab | the repository-related buttons]] in the GUI.
* In an ARM project filesystem, zypper or libzypp are broken, they do not see '''noarch''' packages. This problem was reported with zypper 1.5.3 and libzypp 8.12.1. We suggest you to update your zypper version to 1.6+. For convenience, we pre-built zypper 1.6.15 and libzypp 9.10.2 to Meego 1.2.0.

=== How to install zypper 1.6.15 from our repository in an ARM project filesystem ===
==== From commandline ====
First add our repository to your filesystem's zypper configuration file:
obslight filesystem repositories add http://repo.pub.meego.com/Project:/OBS_Light:/Zypper/MeeGo_1.2_OSS/ "Zypper_1.6.15_backport" $ProjectName

Then chroot in the filesystem and update '''zypper''':
obslight filesystem enter $ProjectName
$ zypper update zypper
$ exit
==== From GUI ====
* ''Project filesystem'' tab, ''Repository''->''New'', URL http://repo.pub.meego.com/Project:/OBS_Light:/Zypper/MeeGo_1.2_OSS/ and alias "Zypper_1.6.15_backport"
* Then ''Project filesystem''->''Open terminal''
# zypper update zypper
# exit

== <tt>"error: Architecture is not included: armv8el"</tt> ==
The '''build''' package of your project filesystem does not support armv8el builds. Consider using another version, like the 2011.03.29 of MeeGo's repositories.

=== How to install '''build''' version 2011.03.29 in a MeeGo 1.2.0 project filesystem ===
First add the MeeGo building tools repository to your project filesystem's zypper configuration file:
obslight filesystem repositories add http://download.meego.com/live/Tools:/Building/MeeGo_1.2.0/ "Tools:Building_MeeGo_1.2.0" $ProjectName

Then chroot in the filesystem and update '''build''':
obslight filesystem enter $ProjectName
# zypper update build
# exit

== <tt>"chroot: failed to run command `sh': No such file or directory"</tt> ==
This appears when '''binfmt_misc''' is not or badly configured.
Launch qemu's binfmt configuration script (as root):
qemu-binfmt-conf.sh
If you still get the same message, try this (as root):
echo -1 > /proc/sys/fs/binfmt_misc/arm
echo ":arm:M::\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x28\x00:\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff:`which qemu-arm`:" > /proc/sys/fs/binfmt_misc/register

== gnomekeyring.IOError ==
This error appears on Ubuntu when running obslight from a console, without a graphical environment. At the moment, the only known solution is to run obslight only from a graphical environment (e.g. Gnome).

== <tt>"sudo: sorry, you must have a tty to run sudo"</tt> ==
This message may appear in logs if the '''requiretty''' option is set in sudo configuration file. Edit ''/etc/sudoers'' and comment out the following line:
Defaults requiretty

= Internals =
== ObsLight GUI ==
[[File: ObsLightGui_class_diagram.png|link=http://wiki.meego.com/images/ObsLightGui_class_diagram.png|OBS Light GUI class diagram, click to see full size]]

[https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/Doc/dia_Resource/ObsLightGui_class_diagram.dia Dia source file]

== ObsLight command line ==
[[File: Doc_ObsLightCommandLine_class_diagram.png|link=http://wiki.meego.com/File:Doc_ObsLightCommandLine_class_diagram.png|OBS Light command line class diagram, click to see full size]]

[https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/Doc/dia_Resource/Doc_ObsLightCommandLine_class_diagram.dia Dia source file]

== ObsLight API Manager ==
[[File: Doc_ObsLight_API_Manager_class_diagram.png|link=http://wiki.meego.com/File:Doc_ObsLight_API_Manager_class_diagram.png|OBS Light API Manager class diagram, click to see full size]]

[https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/Doc/dia_Resource/Doc_ObsLight_API_Manager_class_diagram.dia Dia source file]

= Testing =
== Infrastructure ==
You can find in [https://meego.gitorious.org/meego-developer-tools/obs-light OBS Light Git repository] some configuration files for [http://vagrantup.com/ Vagrant] and [https://github.com/jedi4ever/veewee Veewee]. Using them, you can build reference virtual machines (Fedora 16, openSUSE 12.1 and Ubuntu 11.10) and run test suites on them.
# Make a copy of a base virtual machine
# Copy test script and associated files in a shared folder
# Run virtual machine
# Run test script inside virtual machine with SSH
# Get results from shared folder
# Destroy (or just stop in case of failure) virtual machine
The complete procedure is explained in a [https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/test/veewee/README README].

== Test scenarios ==
Currently we provide only one test scenario:
# install OBS Light
# configure a server
# import a project
# create project filesystem
# import some packages (vim, tzdata, fastinit)
# execute preparation step of these packages
# build the RPMs of these packages
This scenario is implemented in a shell script, available [https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/test/update_and_run_tests.sh here].

File:Tizen OBS-Light-V2.1.pdf

2012-05-08T21:58:38Z

Dominig: OBS Light presentation done at the Tizen's Developers conference On May 7th in San Francisco, Ca, USA

OBS Light presentation done at the Tizen's Developers conference
On May 7th in San Francisco, Ca, USA

TV security

2012-05-04T05:43:21Z

Dominig: Created page with "= MeeGo TV Security = == 1, Short expression of the need == == 2, Purpose/audience == == 3, Overview =="

= MeeGo TV Security =

== 1, Short expression of the need ==

== 2, Purpose/audience ==

== 3, Overview ==

HowTo upgrade from OBS server 2.2 to 2.3

2012-04-05T17:51:56Z

Dominig: /* Setup and configure apache2 for the api and webui */

== Standard upgrade ==
Simply update your OpenSUSE distro which is the base of the OBS server appliance.
zypper update

* If you are lucky and that every thing works find. Don't go through the following process.
* If after the update, nothing works, I hepe the following instruction will help you.

This file briefly describes how to setup an OBS Light Server
(OBS) after an update to the version 2.3.xxx
(note the v 2.2.992 behaves like a 2.3)

You will not the problem as after that upgrade nothing work :-(

You will need :

- upgrade your databased schema
- move from lighthttpd to apache2 (the best thing in that move)
- move to https
- change your default OBS config in OBS light to point to https and the new api port.
- potentially recover some icons (sse joined tar file in this wiki page)

===Update the internal DB after the upgrade===

* Stop all the OBS services

find /etc/init.d/ -name obs\* -exec echo {} stop \;

* install the package require to run the DB upgrade.

zypper in rubygem-rdoc

* re- populate the database

cd /srv/www/obs/api/
sudo RAILS_ENV="production" rake db:setup
sudo chown -R wwwrun.www log tmp

cd /srv/www/obs/webui/
sudo RAILS_ENV="production" rake db:setup
sudo chown -R wwwrun.www log tmp

===Enforce the hostname===

As getting the DNS fully correctly and configured is not that easy and not always under your control, you need to check that the right hostname will be return by the system

hostname -f

If the result is not obslightserver

echo "obslightserver" > /etc/HOSTNAME

Do not let dhcp change the hostname
vim /etc/sysconfig/network/dhcp
DHCLIENT_SET_HOSTNAME="no"

===Setup and configure apache2 for the api and webui===

Now we need to configure the webserver. By default, you can reach the
familiar web user interface on port 443 (e.g: https://localhost), the api
on port 444 (e.g. https://localhost:444), and the repos on port 82 (once
some packages are built).

'''Note:''' If you configure a mobile OBS (e.g. a laptop for training or demos) or that you are connecting on a network where you IP address or name is not stable (e.g. a VPN), you do '''not''' want to activate ssh. 
In that case comment all related ssh parameter and replace https:// by http:// in config file.

Note these is a change from the previous ports allocation. You can either change
the new default port back to the previous 80 and 82 or keep the new one and change your
OBS configuration (I assume the later as I prefer to be in line with new documentation)

An overview page about your OBS instance can be found behind http://obslightserver

The obs-api package comes with a apache vhost file, which does not need to get
modified when you stay with these defaults: /etc/apache2/vhosts.d/obs.conf

Install the required packages via

zypper in obs-api apache2 apache2-mod_xforward rubygem-passenger-apache2

Add the follwing apache modules in /etc/sysconfig/apache2:

APACHE_MODULES="... passenger rewrite proxy proxy_http xforward headers"

Enable SSL in /etc/sysconfig/apache2 via

APACHE_SERVER_FLAGS="-DSSL"

Enable a local config to force server name to be obslightserver

APACHE_CONF_INCLUDE_DIRS="local.d/*.config"

Create the apapche local config files

mkdir /etc/apache2/local.d/
echo "ServerName obslightserver" > /etc/apache2/local.d/serverName.conf

Correct the name of the server in the default static page
(depending of your dns configuration, it might be incorrect)

vi /srv/www/obs/overview/index.html
<a href="https://obslightserver">The OBS webui</a> can be used to setup OBS, browse the content and to build packages.
<a href="https://obslightserver:444">The OBS api URL(https://obslightserver:444)</a> can be used in clients like osc and to manage user accounts via a browser.
<a href="http://obslightserver:82">The OBS repositories</a> contain the build results, the repositories can be added to package managers like zypper or apt.

Generate an ssl certificate via following commands:
Note
# a default certificate already exists but re-creating one with the right IP address is good practice.
# The Common Name [CN] '''must''' be the same than your server name ''(in our case obslightserver)'' or osc ''(V 0.134.1)'' will reject the connection to the API.

mkdir /srv/obs/certs
openssl genrsa -out /srv/obs/certs/server.key 1024
openssl req -new -key /srv/obs/certs/server.key \
-out /srv/obs/certs/server.csr
openssl x509 -req -days 365 -in /srv/obs/certs/server.csr \
-signkey /srv/obs/certs/server.key -out /srv/obs/certs/server.crt
cat /srv/obs/certs/server.key /srv/obs/certs/server.crt \
> /srv/obs/certs/server.pem

===/srv/www/obs/webui/config/options.yml===

If you change the hostnames/IPs of the api, you need to adjust
"source_server_url" accordingly in

/srv/www/obs/webui/config/options.yml

You should set "exception_recipients" to a valid mail address which
should receive notification mail if the WebUI hits any program exception.

It is recommended to enable

use_xforward:true

as well here.

===Change /srv/www/obs/api/config/options.yml===

If you change the hostnames/ips of the api, you need to adjust
"source_server_url" accordingly in

/srv/www/obs/api/config/options.yml

You should set "exception_recipients" to a valid mail address which
should receive notification mail if the API hits any program exception.

It is recommended to enable

use_xforward:true

as well here.

===Restart apache2===

Afterwards you can start the OBS web api via

rcapache2 start # use "insserv apache2" for permanent start
rcobsapidelayed start # use "insserv obsapidelayed" for permanent start

===Deactivate Light HTTPD===

insserv -r lighttpd

===Changing the default URLs===

To change (if needed) the default URLs of the api, configure the apache2 vhosts
accordingly. Edit /etc/apache2/vhosts.d/obs.conf and add the new virtual
hostnames.

Then change the FRONTEND_HOST variable in
/srv/www/obs/webui/config/environments/production.rb
to also point to the new api URL.

The config.yml from chap. 3 and 4 lust be in line with that config
as well as the file /srv/www/obs/overview/index.html

===The WebUI miss some icons===

The current update process seems to create circular links you can find them by running the command
find /srv/www/obs/ -name package_add.png -exec file {} \;

If that is the case, I have uploaded on this wiki the correct images and icons. You will find them in [[File:Bento-images.tgz]]

cd /srv/www/obs/webui/public/themes/bento
tar xzvf bento-image.tgz

===Using osc with your local build service:===

In order to use the command line tool for the build service, run osc with

osc -A https://obslightserver:444 ls

for example. osc asks the first time for a user and password pair.

===Miscellaneous notes===

* logs are located in various directories.

apache2: /var/log/apache2
obs: /srv/obs/log
api: /srv/www/obs/api/log
webui: /srv/www/obs/webui/log

HowTo upgrade from OBS server 2.2 to 2.3

2012-04-04T15:32:48Z

Dominig: /* Enforce the hostname */

== Standard upgrade ==
Simply update your OpenSUSE distro which is the base of the OBS server appliance.
zypper update

* If you are lucky and that every thing works find. Don't go through the following process.
* If after the update, nothing works, I hepe the following instruction will help you.

This file briefly describes how to setup an OBS Light Server
(OBS) after an update to the version 2.3.xxx
(note the v 2.2.992 behaves like a 2.3)

You will not the problem as after that upgrade nothing work :-(

You will need :

- upgrade your databased schema
- move from lighthttpd to apache2 (the best thing in that move)
- move to https
- change your default OBS config in OBS light to point to https and the new api port.
- potentially recover some icons (sse joined tar file in this wiki page)

===Update the internal DB after the upgrade===

* Stop all the OBS services

find /etc/init.d/ -name obs\* -exec echo {} stop \;

* install the package require to run the DB upgrade.

zypper in rubygem-rdoc

* re- populate the database

cd /srv/www/obs/api/
sudo RAILS_ENV="production" rake db:setup
sudo chown -R wwwrun.www log tmp

cd /srv/www/obs/webui/
sudo RAILS_ENV="production" rake db:setup
sudo chown -R wwwrun.www log tmp

===Enforce the hostname===

As getting the DNS fully correctly and configured is not that easy and not always under your control, you need to check that the right hostname will be return by the system

hostname -f

If the result is not obslightserver

echo "obslightserver" > /etc/HOSTNAME

Do not let dhcp change the hostname
vim /etc/sysconfig/network/dhcp
DHCLIENT_SET_HOSTNAME="no"

===Setup and configure apache2 for the api and webui===

Now we need to configure the webserver. By default, you can reach the
familiar web user interface on port 443 (e.g: https://localhost), the api
on port 444 (e.g. https://localhost:444), and the repos on port 82 (once
some packages are built).

Note these is a change from the previous ports allocation. You can either change
the new default port back to the previous 80 and 82 or keep the new one and change your
OBS configuration (I assume the later as I prefer to be in line with new documentation)

An overview page about your OBS instance can be found behind http://obslightserver

The obs-api package comes with a apache vhost file, which does not need to get
modified when you stay with these defaults: /etc/apache2/vhosts.d/obs.conf

Install the required packages via

zypper in obs-api apache2 apache2-mod_xforward rubygem-passenger-apache2

Add the follwing apache modules in /etc/sysconfig/apache2:

APACHE_MODULES="... passenger rewrite proxy proxy_http xforward headers"

Enable SSL in /etc/sysconfig/apache2 via

APACHE_SERVER_FLAGS="-DSSL"

Enable a local config to force server name to be obslightserver

APACHE_CONF_INCLUDE_DIRS="local.d/*.config"

Create the apapche local config files

mkdir /etc/apache2/local.d/
echo "ServerName obslightserver" > /etc/apache2/local.d/serverName.conf

Correct the name of the server in the default static page
(depending of your dns configuration, it might be incorrect)

vi /srv/www/obs/overview/index.html
<a href="https://obslightserver">The OBS webui</a> can be used to setup OBS, browse the content and to build packages.
<a href="https://obslightserver:444">The OBS api URL(https://obslightserver:444)</a> can be used in clients like osc and to manage user accounts via a browser.
<a href="http://obslightserver:82">The OBS repositories</a> contain the build results, the repositories can be added to package managers like zypper or apt.

Generate an ssl certificate via following commands:
Note
# a default certificate already exists but re-creating one with the right IP address is good practice.
# The Common Name [CN] '''must''' be the same than your server name ''(in our case obslightserver)'' or osc ''(V 0.134.1)'' will reject the connection to the API.

mkdir /srv/obs/certs
openssl genrsa -out /srv/obs/certs/server.key 1024
openssl req -new -key /srv/obs/certs/server.key \
-out /srv/obs/certs/server.csr
openssl x509 -req -days 365 -in /srv/obs/certs/server.csr \
-signkey /srv/obs/certs/server.key -out /srv/obs/certs/server.crt
cat /srv/obs/certs/server.key /srv/obs/certs/server.crt \
> /srv/obs/certs/server.pem

===/srv/www/obs/webui/config/options.yml===

If you change the hostnames/IPs of the api, you need to adjust
"source_server_url" accordingly in

/srv/www/obs/webui/config/options.yml

You should set "exception_recipients" to a valid mail address which
should receive notification mail if the WebUI hits any program exception.

It is recommended to enable

use_xforward:true

as well here.

===Change /srv/www/obs/api/config/options.yml===

If you change the hostnames/ips of the api, you need to adjust
"source_server_url" accordingly in

/srv/www/obs/api/config/options.yml

You should set "exception_recipients" to a valid mail address which
should receive notification mail if the API hits any program exception.

It is recommended to enable

use_xforward:true

as well here.

===Restart apache2===

Afterwards you can start the OBS web api via

rcapache2 start # use "insserv apache2" for permanent start
rcobsapidelayed start # use "insserv obsapidelayed" for permanent start

===Deactivate Light HTTPD===

insserv -r lighttpd

===Changing the default URLs===

To change (if needed) the default URLs of the api, configure the apache2 vhosts
accordingly. Edit /etc/apache2/vhosts.d/obs.conf and add the new virtual
hostnames.

Then change the FRONTEND_HOST variable in
/srv/www/obs/webui/config/environments/production.rb
to also point to the new api URL.

The config.yml from chap. 3 and 4 lust be in line with that config
as well as the file /srv/www/obs/overview/index.html

===The WebUI miss some icons===

The current update process seems to create circular links you can find them by running the command
find /srv/www/obs/ -name package_add.png -exec file {} \;

If that is the case, I have uploaded on this wiki the correct images and icons. You will find them in [[File:Bento-images.tgz]]

cd /srv/www/obs/webui/public/themes/bento
tar xzvf bento-image.tgz

===Using osc with your local build service:===

In order to use the command line tool for the build service, run osc with

osc -A https://obslightserver:444 ls

for example. osc asks the first time for a user and password pair.

===Miscellaneous notes===

* logs are located in various directories.

apache2: /var/log/apache2
obs: /srv/obs/log
api: /srv/www/obs/api/log
webui: /srv/www/obs/webui/log

HowTo upgrade from OBS server 2.2 to 2.3

2012-04-04T15:00:06Z

Dominig: /* Update the internal DB after the upgrade */

== Standard upgrade ==
Simply update your OpenSUSE distro which is the base of the OBS server appliance.
zypper update

* If you are lucky and that every thing works find. Don't go through the following process.
* If after the update, nothing works, I hepe the following instruction will help you.

This file briefly describes how to setup an OBS Light Server
(OBS) after an update to the version 2.3.xxx
(note the v 2.2.992 behaves like a 2.3)

You will not the problem as after that upgrade nothing work :-(

You will need :

- upgrade your databased schema
- move from lighthttpd to apache2 (the best thing in that move)
- move to https
- change your default OBS config in OBS light to point to https and the new api port.
- potentially recover some icons (sse joined tar file in this wiki page)

===Update the internal DB after the upgrade===

* Stop all the OBS services

find /etc/init.d/ -name obs\* -exec echo {} stop \;

* install the package require to run the DB upgrade.

zypper in rubygem-rdoc

* re- populate the database

cd /srv/www/obs/api/
sudo RAILS_ENV="production" rake db:setup
sudo chown -R wwwrun.www log tmp

cd /srv/www/obs/webui/
sudo RAILS_ENV="production" rake db:setup
sudo chown -R wwwrun.www log tmp

===Enforce the hostname===

As getting the DNS fully correctly and configured is not that easy and not always under your control, you need to check that the right hostname will be return by the system

hostname -f

If the result is not obslightserver

echo "obslightserver" > /etc/HOSTNAME

===Setup and configure apache2 for the api and webui===

Now we need to configure the webserver. By default, you can reach the
familiar web user interface on port 443 (e.g: https://localhost), the api
on port 444 (e.g. https://localhost:444), and the repos on port 82 (once
some packages are built).

Note these is a change from the previous ports allocation. You can either change
the new default port back to the previous 80 and 82 or keep the new one and change your
OBS configuration (I assume the later as I prefer to be in line with new documentation)

An overview page about your OBS instance can be found behind http://obslightserver

The obs-api package comes with a apache vhost file, which does not need to get
modified when you stay with these defaults: /etc/apache2/vhosts.d/obs.conf

Install the required packages via

zypper in obs-api apache2 apache2-mod_xforward rubygem-passenger-apache2

Add the follwing apache modules in /etc/sysconfig/apache2:

APACHE_MODULES="... passenger rewrite proxy proxy_http xforward headers"

Enable SSL in /etc/sysconfig/apache2 via

APACHE_SERVER_FLAGS="-DSSL"

Enable a local config to force server name to be obslightserver

APACHE_CONF_INCLUDE_DIRS="local.d/*.config"

Create the apapche local config files

mkdir /etc/apache2/local.d/
echo "ServerName obslightserver" > /etc/apache2/local.d/serverName.conf

Correct the name of the server in the default static page
(depending of your dns configuration, it might be incorrect)

vi /srv/www/obs/overview/index.html
<a href="https://obslightserver">The OBS webui</a> can be used to setup OBS, browse the content and to build packages.
<a href="https://obslightserver:444">The OBS api URL(https://obslightserver:444)</a> can be used in clients like osc and to manage user accounts via a browser.
<a href="http://obslightserver:82">The OBS repositories</a> contain the build results, the repositories can be added to package managers like zypper or apt.

Generate an ssl certificate via following commands:
Note
# a default certificate already exists but re-creating one with the right IP address is good practice.
# The Common Name [CN] '''must''' be the same than your server name ''(in our case obslightserver)'' or osc ''(V 0.134.1)'' will reject the connection to the API.

mkdir /srv/obs/certs
openssl genrsa -out /srv/obs/certs/server.key 1024
openssl req -new -key /srv/obs/certs/server.key \
-out /srv/obs/certs/server.csr
openssl x509 -req -days 365 -in /srv/obs/certs/server.csr \
-signkey /srv/obs/certs/server.key -out /srv/obs/certs/server.crt
cat /srv/obs/certs/server.key /srv/obs/certs/server.crt \
> /srv/obs/certs/server.pem

===/srv/www/obs/webui/config/options.yml===

If you change the hostnames/IPs of the api, you need to adjust
"source_server_url" accordingly in

/srv/www/obs/webui/config/options.yml

You should set "exception_recipients" to a valid mail address which
should receive notification mail if the WebUI hits any program exception.

It is recommended to enable

use_xforward:true

as well here.

===Change /srv/www/obs/api/config/options.yml===

If you change the hostnames/ips of the api, you need to adjust
"source_server_url" accordingly in

/srv/www/obs/api/config/options.yml

You should set "exception_recipients" to a valid mail address which
should receive notification mail if the API hits any program exception.

It is recommended to enable

use_xforward:true

as well here.

===Restart apache2===

Afterwards you can start the OBS web api via

rcapache2 start # use "insserv apache2" for permanent start
rcobsapidelayed start # use "insserv obsapidelayed" for permanent start

===Deactivate Light HTTPD===

insserv -r lighttpd

===Changing the default URLs===

To change (if needed) the default URLs of the api, configure the apache2 vhosts
accordingly. Edit /etc/apache2/vhosts.d/obs.conf and add the new virtual
hostnames.

Then change the FRONTEND_HOST variable in
/srv/www/obs/webui/config/environments/production.rb
to also point to the new api URL.

The config.yml from chap. 3 and 4 lust be in line with that config
as well as the file /srv/www/obs/overview/index.html

===The WebUI miss some icons===

The current update process seems to create circular links you can find them by running the command
find /srv/www/obs/ -name package_add.png -exec file {} \;

If that is the case, I have uploaded on this wiki the correct images and icons. You will find them in [[File:Bento-images.tgz]]

cd /srv/www/obs/webui/public/themes/bento
tar xzvf bento-image.tgz

===Using osc with your local build service:===

In order to use the command line tool for the build service, run osc with

osc -A https://obslightserver:444 ls

for example. osc asks the first time for a user and password pair.

===Miscellaneous notes===

* logs are located in various directories.

apache2: /var/log/apache2
obs: /srv/obs/log
api: /srv/www/obs/api/log
webui: /srv/www/obs/webui/log

HowTo upgrade from OBS server 2.2 to 2.3

2012-04-04T14:56:44Z

Dominig: /* Setup and configure apache2 for the api and webui */

== Standard upgrade ==
Simply update your OpenSUSE distro which is the base of the OBS server appliance.
zypper update

* If you are lucky and that every thing works find. Don't go through the following process.
* If after the update, nothing works, I hepe the following instruction will help you.

This file briefly describes how to setup an OBS Light Server
(OBS) after an update to the version 2.3.xxx
(note the v 2.2.992 behaves like a 2.3)

You will not the problem as after that upgrade nothing work :-(

You will need :

- upgrade your databased schema
- move from lighthttpd to apache2 (the best thing in that move)
- move to https
- change your default OBS config in OBS light to point to https and the new api port.
- potentially recover some icons (sse joined tar file in this wiki page)

===Update the internal DB after the upgrade===

* Stop all the OBS services

find /etc/init.d/ -name obs\* -exec echo {} stop \;

* install the package require to run the DB upgrade.

zypper in rubygem-rdoc

* re- populate the database

cd /srv/www/obs/api/
sudo RAILS_ENV="production" rake db:setup
sudo chown -R wwwrun.www log tmp

cd /srv/www/obs/webui/
sudo RAILS_ENV="production" rake db:setup
sudo chown -R wwwrun.www log tmp

===Setup and configure apache2 for the api and webui===

Now we need to configure the webserver. By default, you can reach the
familiar web user interface on port 443 (e.g: https://localhost), the api
on port 444 (e.g. https://localhost:444), and the repos on port 82 (once
some packages are built).

Note these is a change from the previous ports allocation. You can either change
the new default port back to the previous 80 and 82 or keep the new one and change your
OBS configuration (I assume the later as I prefer to be in line with new documentation)

An overview page about your OBS instance can be found behind http://obslightserver

The obs-api package comes with a apache vhost file, which does not need to get
modified when you stay with these defaults: /etc/apache2/vhosts.d/obs.conf

Install the required packages via

zypper in obs-api apache2 apache2-mod_xforward rubygem-passenger-apache2

Add the follwing apache modules in /etc/sysconfig/apache2:

APACHE_MODULES="... passenger rewrite proxy proxy_http xforward headers"

Enable SSL in /etc/sysconfig/apache2 via

APACHE_SERVER_FLAGS="-DSSL"

Enable a local config to force server name to be obslightserver

APACHE_CONF_INCLUDE_DIRS="local.d/*.config"

Create the apapche local config files

mkdir /etc/apache2/local.d/
echo "ServerName obslightserver" > /etc/apache2/local.d/serverName.conf

Correct the name of the server in the default static page
(depending of your dns configuration, it might be incorrect)

vi /srv/www/obs/overview/index.html
<a href="https://obslightserver">The OBS webui</a> can be used to setup OBS, browse the content and to build packages.
<a href="https://obslightserver:444">The OBS api URL(https://obslightserver:444)</a> can be used in clients like osc and to manage user accounts via a browser.
<a href="http://obslightserver:82">The OBS repositories</a> contain the build results, the repositories can be added to package managers like zypper or apt.

Generate an ssl certificate via following commands:
Note
# a default certificate already exists but re-creating one with the right IP address is good practice.
# The Common Name [CN] '''must''' be the same than your server name ''(in our case obslightserver)'' or osc ''(V 0.134.1)'' will reject the connection to the API.

mkdir /srv/obs/certs
openssl genrsa -out /srv/obs/certs/server.key 1024
openssl req -new -key /srv/obs/certs/server.key \
-out /srv/obs/certs/server.csr
openssl x509 -req -days 365 -in /srv/obs/certs/server.csr \
-signkey /srv/obs/certs/server.key -out /srv/obs/certs/server.crt
cat /srv/obs/certs/server.key /srv/obs/certs/server.crt \
> /srv/obs/certs/server.pem

===/srv/www/obs/webui/config/options.yml===

If you change the hostnames/IPs of the api, you need to adjust
"source_server_url" accordingly in

/srv/www/obs/webui/config/options.yml

You should set "exception_recipients" to a valid mail address which
should receive notification mail if the WebUI hits any program exception.

It is recommended to enable

use_xforward:true

as well here.

===Change /srv/www/obs/api/config/options.yml===

If you change the hostnames/ips of the api, you need to adjust
"source_server_url" accordingly in

/srv/www/obs/api/config/options.yml

You should set "exception_recipients" to a valid mail address which
should receive notification mail if the API hits any program exception.

It is recommended to enable

use_xforward:true

as well here.

===Restart apache2===

Afterwards you can start the OBS web api via

rcapache2 start # use "insserv apache2" for permanent start
rcobsapidelayed start # use "insserv obsapidelayed" for permanent start

===Deactivate Light HTTPD===

insserv -r lighttpd

===Changing the default URLs===

To change (if needed) the default URLs of the api, configure the apache2 vhosts
accordingly. Edit /etc/apache2/vhosts.d/obs.conf and add the new virtual
hostnames.

Then change the FRONTEND_HOST variable in
/srv/www/obs/webui/config/environments/production.rb
to also point to the new api URL.

The config.yml from chap. 3 and 4 lust be in line with that config
as well as the file /srv/www/obs/overview/index.html

===The WebUI miss some icons===

The current update process seems to create circular links you can find them by running the command
find /srv/www/obs/ -name package_add.png -exec file {} \;

If that is the case, I have uploaded on this wiki the correct images and icons. You will find them in [[File:Bento-images.tgz]]

cd /srv/www/obs/webui/public/themes/bento
tar xzvf bento-image.tgz

===Using osc with your local build service:===

In order to use the command line tool for the build service, run osc with

osc -A https://obslightserver:444 ls

for example. osc asks the first time for a user and password pair.

===Miscellaneous notes===

* logs are located in various directories.

apache2: /var/log/apache2
obs: /srv/obs/log
api: /srv/www/obs/api/log
webui: /srv/www/obs/webui/log

HowTo upgrade from OBS server 2.2 to 2.3

2012-04-04T13:54:57Z

Dominig: /* Restart apache2 */

== Standard upgrade ==
Simply update your OpenSUSE distro which is the base of the OBS server appliance.
zypper update

* If you are lucky and that every thing works find. Don't go through the following process.
* If after the update, nothing works, I hepe the following instruction will help you.

This file briefly describes how to setup an OBS Light Server
(OBS) after an update to the version 2.3.xxx
(note the v 2.2.992 behaves like a 2.3)

You will not the problem as after that upgrade nothing work :-(

You will need :

- upgrade your databased schema
- move from lighthttpd to apache2 (the best thing in that move)
- move to https
- change your default OBS config in OBS light to point to https and the new api port.
- potentially recover some icons (sse joined tar file in this wiki page)

===Update the internal DB after the upgrade===

* Stop all the OBS services

find /etc/init.d/ -name obs\* -exec echo {} stop \;

* install the package require to run the DB upgrade.

zypper in rubygem-rdoc

* re- populate the database

cd /srv/www/obs/api/
sudo RAILS_ENV="production" rake db:setup
sudo chown -R wwwrun.www log tmp

cd /srv/www/obs/webui/
sudo RAILS_ENV="production" rake db:setup
sudo chown -R wwwrun.www log tmp

===Setup and configure apache2 for the api and webui===

Now we need to configure the webserver. By default, you can reach the
familiar web user interface on port 443 (e.g: https://localhost), the api
on port 444 (e.g. https://localhost:444), and the repos on port 82 (once
some packages are built).

Note these is a change from the previous ports allocation. You can either change
the new default port back to the previous 80 and 82 or keep the new one and change your
OBS configuration (I assume the later as I prefer to be in line with new documentation)

An overview page about your OBS instance can be found behind http://obslightserver

The obs-api package comes with a apache vhost file, which does not need to get
modified when you stay with these defaults: /etc/apache2/vhosts.d/obs.conf

Install the required packages via

zypper in obs-api apache2 apache2-mod_xforward rubygem-passenger-apache2

Add the follwing apache modules in /etc/sysconfig/apache2:

APACHE_MODULES="... passenger rewrite proxy proxy_http xforward headers"

Enable SSL in /etc/sysconfig/apache2 via

APACHE_SERVER_FLAGS="-DSSL"

Enable a local config to force server name to be obslightserver

APACHE_CONF_INCLUDE_DIRS="local.d/*.config"

Create the apapche local config files

mkdir /etc/apache2/local.d/
echo "ServerName obslightserver" > /etc/apache2/local.d/serverName.conf

Correct the name of the server in the default static page
(depending of your dns configuration, it might be incorrect)

vi /srv/www/obs/overview/index.html
<a href="https://obslightserver">The OBS webui</a> can be used to setup OBS, browse the content and to build packages.
<a href="https://obslightserver:444">The OBS api URL(https://obslightserver:444)</a> can be used in clients like osc and to manage user accounts via a browser.
<a href="http://obslightserver:82">The OBS repositories</a> contain the build results, the repositories can be added to package managers like zypper or apt.

Generate an ssl certificate via following commands:
Note a default certificate already exists but re-creating one with the right IP address is prefereable.

mkdir /srv/obs/certs
openssl genrsa -out /srv/obs/certs/server.key 1024
openssl req -new -key /srv/obs/certs/server.key \
-out /srv/obs/certs/server.csr
openssl x509 -req -days 365 -in /srv/obs/certs/server.csr \
-signkey /srv/obs/certs/server.key -out /srv/obs/certs/server.crt
cat /srv/obs/certs/server.key /srv/obs/certs/server.crt \
> /srv/obs/certs/server.pem

===/srv/www/obs/webui/config/options.yml===

If you change the hostnames/IPs of the api, you need to adjust
"source_server_url" accordingly in

/srv/www/obs/webui/config/options.yml

You should set "exception_recipients" to a valid mail address which
should receive notification mail if the WebUI hits any program exception.

It is recommended to enable

use_xforward:true

as well here.

===Change /srv/www/obs/api/config/options.yml===

If you change the hostnames/ips of the api, you need to adjust
"source_server_url" accordingly in

/srv/www/obs/api/config/options.yml

You should set "exception_recipients" to a valid mail address which
should receive notification mail if the API hits any program exception.

It is recommended to enable

use_xforward:true

as well here.

===Restart apache2===

Afterwards you can start the OBS web api via

rcapache2 start # use "insserv apache2" for permanent start
rcobsapidelayed start # use "insserv obsapidelayed" for permanent start

===Deactivate Light HTTPD===

insserv -r lighttpd

===Changing the default URLs===

To change (if needed) the default URLs of the api, configure the apache2 vhosts
accordingly. Edit /etc/apache2/vhosts.d/obs.conf and add the new virtual
hostnames.

Then change the FRONTEND_HOST variable in
/srv/www/obs/webui/config/environments/production.rb
to also point to the new api URL.

The config.yml from chap. 3 and 4 lust be in line with that config
as well as the file /srv/www/obs/overview/index.html

===The WebUI miss some icons===

The current update process seems to create circular links you can find them by running the command
find /srv/www/obs/ -name package_add.png -exec file {} \;

If that is the case, I have uploaded on this wiki the correct images and icons. You will find them in [[File:Bento-images.tgz]]

cd /srv/www/obs/webui/public/themes/bento
tar xzvf bento-image.tgz

===Using osc with your local build service:===

In order to use the command line tool for the build service, run osc with

osc -A https://obslightserver:444 ls

for example. osc asks the first time for a user and password pair.

===Miscellaneous notes===

* logs are located in various directories.

apache2: /var/log/apache2
obs: /srv/obs/log
api: /srv/www/obs/api/log
webui: /srv/www/obs/webui/log

HowTo upgrade from OBS server 2.2 to 2.3

2012-04-02T16:28:59Z

Dominig: /* Changing the default URLs */

== Standard upgrade ==
Simply update your OpenSUSE distro which is the base of the OBS server appliance.
zypper update

* If you are lucky and that every thing works find. Don't go through the following process.
* If after the update, nothing works, I hepe the following instruction will help you.

This file briefly describes how to setup an OBS Light Server
(OBS) after an update to the version 2.3.xxx
(note the v 2.2.992 behaves like a 2.3)

You will not the problem as after that upgrade nothing work :-(

You will need :

- upgrade your databased schema
- move from lighthttpd to apache2 (the best thing in that move)
- move to https
- change your default OBS config in OBS light to point to https and the new api port.
- potentially recover some icons (sse joined tar file in this wiki page)

===Update the internal DB after the upgrade===

* Stop all the OBS services

find /etc/init.d/ -name obs\* -exec echo {} stop \;

* install the package require to run the DB upgrade.

zypper in rubygem-rdoc

* re- populate the database

cd /srv/www/obs/api/
sudo RAILS_ENV="production" rake db:setup
sudo chown -R wwwrun.www log tmp

cd /srv/www/obs/webui/
sudo RAILS_ENV="production" rake db:setup
sudo chown -R wwwrun.www log tmp

===Setup and configure apache2 for the api and webui===

Now we need to configure the webserver. By default, you can reach the
familiar web user interface on port 443 (e.g: https://localhost), the api
on port 444 (e.g. https://localhost:444), and the repos on port 82 (once
some packages are built).

Note these is a change from the previous ports allocation. You can either change
the new default port back to the previous 80 and 82 or keep the new one and change your
OBS configuration (I assume the later as I prefer to be in line with new documentation)

An overview page about your OBS instance can be found behind http://obslightserver

The obs-api package comes with a apache vhost file, which does not need to get
modified when you stay with these defaults: /etc/apache2/vhosts.d/obs.conf

Install the required packages via

zypper in obs-api apache2 apache2-mod_xforward rubygem-passenger-apache2

Add the follwing apache modules in /etc/sysconfig/apache2:

APACHE_MODULES="... passenger rewrite proxy proxy_http xforward headers"

Enable SSL in /etc/sysconfig/apache2 via

APACHE_SERVER_FLAGS="-DSSL"

Enable a local config to force server name to be obslightserver

APACHE_CONF_INCLUDE_DIRS="local.d/*.config"

Create the apapche local config files

mkdir /etc/apache2/local.d/
echo "ServerName obslightserver" > /etc/apache2/local.d/serverName.conf

Correct the name of the server in the default static page
(depending of your dns configuration, it might be incorrect)

vi /srv/www/obs/overview/index.html
<a href="https://obslightserver">The OBS webui</a> can be used to setup OBS, browse the content and to build packages.
<a href="https://obslightserver:444">The OBS api URL(https://obslightserver:444)</a> can be used in clients like osc and to manage user accounts via a browser.
<a href="http://obslightserver:82">The OBS repositories</a> contain the build results, the repositories can be added to package managers like zypper or apt.

Generate an ssl certificate via following commands:
Note a default certificate already exists but re-creating one with the right IP address is prefereable.

mkdir /srv/obs/certs
openssl genrsa -out /srv/obs/certs/server.key 1024
openssl req -new -key /srv/obs/certs/server.key \
-out /srv/obs/certs/server.csr
openssl x509 -req -days 365 -in /srv/obs/certs/server.csr \
-signkey /srv/obs/certs/server.key -out /srv/obs/certs/server.crt
cat /srv/obs/certs/server.key /srv/obs/certs/server.crt \
> /srv/obs/certs/server.pem

===/srv/www/obs/webui/config/options.yml===

If you change the hostnames/IPs of the api, you need to adjust
"source_server_url" accordingly in

/srv/www/obs/webui/config/options.yml

You should set "exception_recipients" to a valid mail address which
should receive notification mail if the WebUI hits any program exception.

It is recommended to enable

use_xforward:true

as well here.

===Change /srv/www/obs/api/config/options.yml===

If you change the hostnames/ips of the api, you need to adjust
"source_server_url" accordingly in

/srv/www/obs/api/config/options.yml

You should set "exception_recipients" to a valid mail address which
should receive notification mail if the API hits any program exception.

It is recommended to enable

use_xforward:true

as well here.

===Restart apache2===

Afterwards you can start the OBS web api via

rcapache2 start # use "insserv apache2" for permanent start
rcobsapidelayed start # use "insserv obsapidelayed" for permanent start

===Changing the default URLs===

To change (if needed) the default URLs of the api, configure the apache2 vhosts
accordingly. Edit /etc/apache2/vhosts.d/obs.conf and add the new virtual
hostnames.

Then change the FRONTEND_HOST variable in
/srv/www/obs/webui/config/environments/production.rb
to also point to the new api URL.

The config.yml from chap. 3 and 4 lust be in line with that config
as well as the file /srv/www/obs/overview/index.html

===The WebUI miss some icons===

The current update process seems to create circular links you can find them by running the command
find /srv/www/obs/ -name package_add.png -exec file {} \;

If that is the case, I have uploaded on this wiki the correct images and icons. You will find them in [[File:Bento-images.tgz]]

cd /srv/www/obs/webui/public/themes/bento
tar xzvf bento-image.tgz

===Using osc with your local build service:===

In order to use the command line tool for the build service, run osc with

osc -A https://obslightserver:444 ls

for example. osc asks the first time for a user and password pair.

===Miscellaneous notes===

* logs are located in various directories.

apache2: /var/log/apache2
obs: /srv/obs/log
api: /srv/www/obs/api/log
webui: /srv/www/obs/webui/log

File:Bento-images.tgz

2012-04-02T16:19:41Z

Dominig: Icons for OBS V 2.3 when upgrade mess up the system and creates circular links see http://wiki.meego.com/HowTo_upgrade_from_OBS_server_2.2_to_2.3

Icons for OBS V 2.3 when upgrade mess up the system and creates circular links

see http://wiki.meego.com/HowTo_upgrade_from_OBS_server_2.2_to_2.3

HowTo upgrade from OBS server 2.2 to 2.3

2012-04-02T16:16:27Z

Dominig: Created page with "== Standard upgrade == Simply update your OpenSUSE distro which is the base of the OBS server appliance. zypper update * If you are lucky and that every thing works find. Don'..."

== Standard upgrade ==
Simply update your OpenSUSE distro which is the base of the OBS server appliance.
zypper update

* If you are lucky and that every thing works find. Don't go through the following process.
* If after the update, nothing works, I hepe the following instruction will help you.

This file briefly describes how to setup an OBS Light Server
(OBS) after an update to the version 2.3.xxx
(note the v 2.2.992 behaves like a 2.3)

You will not the problem as after that upgrade nothing work :-(

You will need :

- upgrade your databased schema
- move from lighthttpd to apache2 (the best thing in that move)
- move to https
- change your default OBS config in OBS light to point to https and the new api port.
- potentially recover some icons (sse joined tar file in this wiki page)

===Update the internal DB after the upgrade===

* Stop all the OBS services

find /etc/init.d/ -name obs\* -exec echo {} stop \;

* install the package require to run the DB upgrade.

zypper in rubygem-rdoc

* re- populate the database

cd /srv/www/obs/api/
sudo RAILS_ENV="production" rake db:setup
sudo chown -R wwwrun.www log tmp

cd /srv/www/obs/webui/
sudo RAILS_ENV="production" rake db:setup
sudo chown -R wwwrun.www log tmp

===Setup and configure apache2 for the api and webui===

Now we need to configure the webserver. By default, you can reach the
familiar web user interface on port 443 (e.g: https://localhost), the api
on port 444 (e.g. https://localhost:444), and the repos on port 82 (once
some packages are built).

Note these is a change from the previous ports allocation. You can either change
the new default port back to the previous 80 and 82 or keep the new one and change your
OBS configuration (I assume the later as I prefer to be in line with new documentation)

An overview page about your OBS instance can be found behind http://obslightserver

The obs-api package comes with a apache vhost file, which does not need to get
modified when you stay with these defaults: /etc/apache2/vhosts.d/obs.conf

Install the required packages via

zypper in obs-api apache2 apache2-mod_xforward rubygem-passenger-apache2

Add the follwing apache modules in /etc/sysconfig/apache2:

APACHE_MODULES="... passenger rewrite proxy proxy_http xforward headers"

Enable SSL in /etc/sysconfig/apache2 via

APACHE_SERVER_FLAGS="-DSSL"

Enable a local config to force server name to be obslightserver

APACHE_CONF_INCLUDE_DIRS="local.d/*.config"

Create the apapche local config files

mkdir /etc/apache2/local.d/
echo "ServerName obslightserver" > /etc/apache2/local.d/serverName.conf

Correct the name of the server in the default static page
(depending of your dns configuration, it might be incorrect)

vi /srv/www/obs/overview/index.html
<a href="https://obslightserver">The OBS webui</a> can be used to setup OBS, browse the content and to build packages.
<a href="https://obslightserver:444">The OBS api URL(https://obslightserver:444)</a> can be used in clients like osc and to manage user accounts via a browser.
<a href="http://obslightserver:82">The OBS repositories</a> contain the build results, the repositories can be added to package managers like zypper or apt.

Generate an ssl certificate via following commands:
Note a default certificate already exists but re-creating one with the right IP address is prefereable.

mkdir /srv/obs/certs
openssl genrsa -out /srv/obs/certs/server.key 1024
openssl req -new -key /srv/obs/certs/server.key \
-out /srv/obs/certs/server.csr
openssl x509 -req -days 365 -in /srv/obs/certs/server.csr \
-signkey /srv/obs/certs/server.key -out /srv/obs/certs/server.crt
cat /srv/obs/certs/server.key /srv/obs/certs/server.crt \
> /srv/obs/certs/server.pem

===/srv/www/obs/webui/config/options.yml===

If you change the hostnames/IPs of the api, you need to adjust
"source_server_url" accordingly in

/srv/www/obs/webui/config/options.yml

You should set "exception_recipients" to a valid mail address which
should receive notification mail if the WebUI hits any program exception.

It is recommended to enable

use_xforward:true

as well here.

===Change /srv/www/obs/api/config/options.yml===

If you change the hostnames/ips of the api, you need to adjust
"source_server_url" accordingly in

/srv/www/obs/api/config/options.yml

You should set "exception_recipients" to a valid mail address which
should receive notification mail if the API hits any program exception.

It is recommended to enable

use_xforward:true

as well here.

===Restart apache2===

Afterwards you can start the OBS web api via

rcapache2 start # use "insserv apache2" for permanent start
rcobsapidelayed start # use "insserv obsapidelayed" for permanent start

===Changing the default URLs===

To change (if needed) the default URLs of the api, configure the apache2 vhosts
accordingly. Edit /etc/apache2/vhosts.d/obs.conf and add the new virtual
hostnames.

Then change the FRONTEND_HOST variable in
/srv/www/obs/webui/config/environments/production.rb
to also point to the new api URL.

The config.yml from chap. 3 and 4 lust be in line with that config
as well as the file /srv/www/obs/overview/index.html

===Using osc with your local build service:===

In order to use the command line tool for the build service, run osc with

osc -A https://obslightserver:444 ls

for example. osc asks the first time for a user and password pair.

===Miscellaneous notes===

* logs are located in various directories.

apache2: /var/log/apache2
obs: /srv/obs/log
api: /srv/www/obs/api/log
webui: /srv/www/obs/webui/log

OBS Light FAQ

2012-04-02T16:08:11Z

Dominig: /* Where to send bug reports ? */

= Frequently Asked Questions =
== Where does ''obslight'' store its data? ==
All data is stored in '''~/OBSLight''' and subdirectories.

Each OBS project has its own directory in '''~/OBSLight/ObsProjects/''', each MIC project has its own directory in '''~/OBSLight/MicProjects/'''.

== Is there a configuration file ? ==
Configuration file is '''~/OBSLight/ObslightConfig'''.

== How do I run OBS light server appliance on my Desktop ? ==
While running an OBS Light appliance is simple and easy and just requires 1GB of RAM allocated to the virtual machine, running an OBS server appliance can be much more demanding but running the OBS server server appliance on your desktop or laptop (a minimum 4GB of RAM is mandatory) via a virtual machine can be very handy during evaluation tests. 
The main advantage is that you do not need a special authorisation from your IT department to start playing but you need to allocate at least 2GB to the appliance and as many CPU cores that you can spare. You need to patch on the OBS server appliance ''(need to be root)'' the file '''/etc/sysconfig/obs-worker''' to set the variable OBS_WORKER_INSTANCES to 1 (default is zero) to limit the RAM resources requires by your appliance during build process.
If you plan to build large packages such as Chromium you will need more than 2GB of RAM allocated (actually on my desktop I have 16GB). 
You can overcome that limit with the addition of an obsworker appliance on a separate server. OBS Light project provides one pre-configured to work with and OBS Light server appliance. 
If you use the Bridge mode, external OBS work appliance will be detected and used automatically (NAT more would require a complex configuration). The Worker can be running on a more powerfull unit and speed the preparation work before for example leaving the office with a complete fully built project on a laptop.
You can stop the worker on the laptop by the command '''rcobsworker stop''' ''(need to be root)''. You can check that your OBS Worker appliance can see your OBS Light Server Appliance with the command '''slptool findsrvs obs.source_server''' 
As a general rule using the bridge mode is advisable. Note ''this is '''not''' the default option of VirtualBox''.
The NAT mode is interesting to run an OBS Light server via a VPN or for unconnected demos. In that case you will need to declare NAT rules in your Vitual Machine Manager redirecting the ports 80, 81 and 82 from your local host to your OBS appliance internal NAT address ''(with VitualBox under Linux rerouting port bellow 1000 is reserved for root only)''. 
Do not forget to add a host name "obslightserver" in your workstation pointing to the OBS Light server appliance IP address or localhost in the case of a NAT configuration.

== How to show the log ? ==
* From the menu: ''Window'' -> ''Show log''
* When a long operation is running, there is a button under the progress bar.
* A log file is written in <tt>~/OBSLight/obslight.log</tt>.

== Why does MeeGo's '''kernel''' package fail to build for ARM? ==
The '''kernel''' package has flags to prevent builds on ARM.
To compile an ARM kernel, you must use another package, for example the '''kernel-adaptation-n900''' package.

== How install the dependency of a package into the project filesystem? ==
If the project on your OBS doesn’t provide some dependencies and you must add a repository to your project filesystem's zypper configuration, you have two choices:
* First one, use an URL and an alias:
## obslight filesystem repositories add <repository_url> <repository_alias> <project_alias>
obslight filesystem repositories add http://download.meego.com/live/MeeGo:/1.2:/non-oss/MeeGo_1.2/ MeeGo_non-oss MeeGo_1.2_oss
* Second one, add the repository of another local project:
## obslight filesystem repositories add from <source_project_alias> <project_alias>
obslight filesystem repositories add from MeeGo_1.2_non-oss MeeGo_1.2_oss

== How to create a new package ? (from an existing SPEC file) ==
=== Requirements ===
* A project on an OBS server (public or [http://susestudio.com/a/e0uuBG/meego-obs private]) where you have maintainer rights (for example your home project), and with a [http://en.opensuse.org/openSUSE:Build_Service_Tutorial#Step_Three.C2.A0.E2.80.93_Choose_build_targets build target] already configured.
* An archive of your program, named like <tt>program-version.tar.gz</tt> (<tt>tar.bz2</tt> is OK).
* A valid SPEC file, named <tt>program.spec</tt>.

=== Procedure ===
[[OBS Light]] cannot create new packages at the moment. You have to use the web UI or ''osc'' first.
# Using the web UI:
#* Go to the project you want to add your package to.
#* Go to ''Packages'' tab.
#* Click ''Create package''.
#* Give a name to the package (we recommend the same name as your program, in lower-case), a title and a description (optional but recommended).
# Now you should be able to import this package in [[OBS Light]].
#* Run <tt>obslightgui</tt>.
#* Click ''Import project'' button (on the left-bottom).
#* Select a server from the list or configure a new one.
#* Select your project in the list.
#* Select a target and an architecture.
#* Give an alias to the project (can be the name of the project without "''':'''", we suggest suffixing with the architecture).
#* You should now see a list of packages, with the one you created in web UI.
#* Select it and press ''finish''.
# The package is now imported into OBS Light, with status ''broken'' (because it has no files).
#* In the right panel, select tab ''Local directory'', click ''Import file''.
#* Select your SPEC file and archive (and YAML file if you have one).
#* The files appear in the list with status ''Added''.
#* In the middle panel, click ''Commit changes'', and enter a commit message.
#* The files are uploaded, and the package starts to build on the OBS server.

== How to prepare a Spec file using Spectacle ? ==
*Official documentation: [[Spectacle]]
*Why using Spectacle: [[Packaging/Guidelines#Writing_a_package_from_scratch]]

=== Generate a YAML file from scratch ===
==== Manually ====
Run the following command:
specify --new=your_package_name
It will create a new YAML file from a template, and ask you to edit the file. Just replace "<tt>^^^</tt>" occurrences by which seems appropriate, and got to the [[#Customize_the_Spec_and_YAML_files | Spec and YAML customization section]].

==== Automatically ====
[https://meego.gitorious.org/meego-developer-tools/autospectacle autospectacle] can analyze source archives and generate an appropriate YAML file, but has no documentation.

=== Generate a YAML file from a Spec file ===
If you already have a Spec file for your program, you may still want to create a YAML file in order to standardize or simplify it. Run the following command:
spec2spectacle your_package_name.spec
It will parse your Spec file, generate a YAML file, and generate a new Spec file from the YAML file. Notice that the conversion is not perfect, and you may lost information.

=== Customize the Spec and YAML files ===
Except from lines between "<tt># >> </tt>" and "<tt># << </tt>" tags, the content of the Spec file should not be modified by you, because it will be re-written by <tt>specify</tt> each time you modify the YAML file. So if you see a line you don't like, you have to find which option of the YAML file has generated it (or can prevent it to be generated), change it, and run the following command to update the Spec file:
specify your_package_name.yaml
Complete list of Spectacle options is here: [[Spectacle#Syntax_of_spectacle_YAML | Syntax of spectacle YAML]]

== Where to send bug reports ? ==
Bugs are centralized on [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light MeeGo's bugzilla].

== Help I have updated and broken my OBS server appliance ==
The move to OBS 2.3 seems to be far less transparent that it should.
But the facilities offered by the V 2.3 are valuable and move to it is worthwhile. 
You will find here how I did it, it might work for you but it is without guaranty.
'''Do a snapshot of your appliance before starting'''. 
[[HowTo upgrade from OBS server 2.2 to 2.3]]

= Links =
* [[OBS_Light | OBS Light main page]]
* [[OBS_Light_Installation | OBS Light installation]]
* [[OBS_Light_Manual | OBS Light manual]]
* [https://meego.gitorious.org/meego-developer-tools/obs-light/ OBS Light project on Gitorious]
* [https://build.pub.meego.com/project/show?project=Project%3AOBS_Light OBS Light project on MeeGo build service]

OBS Light

2012-04-02T15:32:25Z

Dominig: /* Where to Download OBS Light? */

[[File:OBSLightWiki.png‎ ]]
[http://blynt.canalblog.com/ Blynt]

= Why should I use OBS Light ?=
* I want to create a [https://meego.com/ MeeGo-based] distribution for my target ([https://meego.com/devices/smart-tv Smart TV], [https://meego.com/devices/in-vehicle In-Vehicle], [https://meego.com/devices/media-phone Media phone], [https://meego.com/devices/netbook Netbook], [https://meego.com/devices/handset Handset] ...).
* I want to include private code into my [https://meego.com/ MeeGo-based] distribution.
* I want to be fast from the beginning of my project to the first boot of my target.
* I want to use the same tools throughout my development cycle.

= Why not use OBS Light ?=
OBS Light is targeting the development of variants of MeeGo distribution (or any OBS build distro) to either add extra features to a MeeGo product or adapt a MeeGo distribution to different hardware configurations.
It is not an another SDK, if you want to develop applications for a MeeGo product you should have a look at the [https://meego.com/developers MeeGo SDK] which likely will better fit your need.

= What is OBS Light ?=
The project 'OBS Light' (or also obslight) , creates an encapsulation of OBS which presents a lighter face of OBS that we have called OBS light which could be delivered (if desired) with a pre-packaged MeeGo TV stack (or any other MeeGo vertical) released on a DVD image. The name was chosen to express that it remains an OBS base development process, but which is lighter to use, the idea of seeing the project as a light to guide the user in the flow of tools such as OBS, OSC, MIC, ... only came later. Once you will also see it incorrectly spell as 'OBS Lite'.

If you have (or are thinking about) selecting MeeGo but you cannot put all the code you want to build on OBS, the public, cloud-based MeeGo building tool, or if you are more comfortable with the tradition of local build tools based on a chroot than with a full cloud-based system like OBS, you might find the learning curve a bit steep.

While OBS will provide you with a very powerful and adapted tool for your long-term needs, the entry cost can be perceived to be too high.
This issue is particularly strongly perceived in the TV or IVI segments where recompilation of the Linux kernel and adding drivers is required even during the very early phases of a project and compiling in the public domain is out of the question.

In a second phase we hope to add a simple UI to it. It reuses the osc command line tools delivered with OBS to which a set of extra plugins have been added, including an extension of mic. All this remains compatible with a full implementation of OBS. It will be published under License: GPLv2.

The osc plugin for automatic patch creation are designed to be reusable in a full OBS environment.

The coding is under work and changes are likely to occur during the development process.

Note that under the hood, OBS light still is 100% OBS code and the building process is the same as what you could achieve by running your own private OBS.
OBS Light mainly pre-configures an OBS with a few osc plugins to ease the learning curve.

Note that some OBS feature are hidden to simplify the learning phase. As the service is run locally, you can mix Open Source and private code should you need to do so.

= Where to Download OBS Light? =

OBS Light is available either as a ready to run appliance to execute as a virtual machine, ready made packages for common distros and obsviously as source file to build it by yourself.

* [http://susestudio.com/a/e0uuBG/meego-obs-light OBS Light appliance], built thanks to Suse studio

* '''[[OBS Light Installation | Up-to-date Builds]]''' for various Linux Distros.

* Videos training and intro [http://www.dailymotion.com/playlist/x1t5ll_dominigarfoll_obs-light-training Starting with OBS Light]

= Where is the information about OBS Light? =
* [[OBS_Light_Manual | OBS Light manual]]
* [[OBS_Light_FAQ | Frequently Asked Questions]]
* You can file bugs on [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light MeeGo's bugzilla]. The bug list for the project can be reached [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light here]. To easily file a new bug, use [https://bugs.meego.com/enter_bug.cgi?product=Development%20Tools this link]

All discussions are run on the MeeGo-distribution-tools mailing list.
http://lists.meego.com/listinfo/meego-distribution-tools

= Where can I find a private OBS appliance? =
You can find a OBS appliance, build in [http://susestudio.com suse studio]:
http://susegallery.com/a/e0uuBG/meego-obs

For more information about private OBS: http://en.opensuse.org/openSUSE:Build_Service_private_instance

You can Download the boot strap of Meego 1.2.0 here (saveOBS.tar.aa -> saveOBS.tar.ba).
http://www.cc-e.co.uk/Meego/MeeGo-1.2.0/
reassembled the file
cat saveOBS.tar.?? >> saveOBS.tar.gz
Thanks to Julien Snell and Cocom for the ftp server.
http://www.cc-e.co.uk

= What difference between OBS and OBS Light? =
OBS Light use an OBS server.
{|
| || '''OBS Light''' || '''Full OBS'''
|-
| Cross compilation || Yes || Yes
|-
| Local and remote reference || Yes || Yes
|-
| Automatic creation of patch || Yes || Not Yet (will if the same osc plugin is loaded)
|-
| Bootable Image creation || Yes || Add on
|-
| Integrated version control || Hidden || Yes
|-
| Multi-user || Hidden || Yes
|-
| Multi-target by project || Hidden || Yes
|-
| Auto built || Hidden || Yes
|-
| Signing service || Hidden || Yes
|}

Initial Specifications (final implementation have differed from the initial concept) :[[https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/Doc/SpecOBSLight-1_V-0-6.pdf SpecOBSLight-1_V-0-6]]

= Where is the OBS Light code? =
GIT: https://meego.gitorious.org/meego-developer-tools/obs-light

OBS: https://build.pub.meego.com/project/show?project=Project%3AOBS_Light

OBS Light

2012-04-02T15:31:52Z

Dominig: /* Download OBS Light? */

[[File:OBSLightWiki.png‎ ]]
[http://blynt.canalblog.com/ Blynt]

= Why should I use OBS Light ?=
* I want to create a [https://meego.com/ MeeGo-based] distribution for my target ([https://meego.com/devices/smart-tv Smart TV], [https://meego.com/devices/in-vehicle In-Vehicle], [https://meego.com/devices/media-phone Media phone], [https://meego.com/devices/netbook Netbook], [https://meego.com/devices/handset Handset] ...).
* I want to include private code into my [https://meego.com/ MeeGo-based] distribution.
* I want to be fast from the beginning of my project to the first boot of my target.
* I want to use the same tools throughout my development cycle.

= Why not use OBS Light ?=
OBS Light is targeting the development of variants of MeeGo distribution (or any OBS build distro) to either add extra features to a MeeGo product or adapt a MeeGo distribution to different hardware configurations.
It is not an another SDK, if you want to develop applications for a MeeGo product you should have a look at the [https://meego.com/developers MeeGo SDK] which likely will better fit your need.

= What is OBS Light ?=
The project 'OBS Light' (or also obslight) , creates an encapsulation of OBS which presents a lighter face of OBS that we have called OBS light which could be delivered (if desired) with a pre-packaged MeeGo TV stack (or any other MeeGo vertical) released on a DVD image. The name was chosen to express that it remains an OBS base development process, but which is lighter to use, the idea of seeing the project as a light to guide the user in the flow of tools such as OBS, OSC, MIC, ... only came later. Once you will also see it incorrectly spell as 'OBS Lite'.

If you have (or are thinking about) selecting MeeGo but you cannot put all the code you want to build on OBS, the public, cloud-based MeeGo building tool, or if you are more comfortable with the tradition of local build tools based on a chroot than with a full cloud-based system like OBS, you might find the learning curve a bit steep.

While OBS will provide you with a very powerful and adapted tool for your long-term needs, the entry cost can be perceived to be too high.
This issue is particularly strongly perceived in the TV or IVI segments where recompilation of the Linux kernel and adding drivers is required even during the very early phases of a project and compiling in the public domain is out of the question.

In a second phase we hope to add a simple UI to it. It reuses the osc command line tools delivered with OBS to which a set of extra plugins have been added, including an extension of mic. All this remains compatible with a full implementation of OBS. It will be published under License: GPLv2.

The osc plugin for automatic patch creation are designed to be reusable in a full OBS environment.

The coding is under work and changes are likely to occur during the development process.

Note that under the hood, OBS light still is 100% OBS code and the building process is the same as what you could achieve by running your own private OBS.
OBS Light mainly pre-configures an OBS with a few osc plugins to ease the learning curve.

Note that some OBS feature are hidden to simplify the learning phase. As the service is run locally, you can mix Open Source and private code should you need to do so.

= Where to Download OBS Light? =

OBS Light is available either as a ready to run appliance to execute as a virtual machine, ready made packages for common distros and obsviously as source file to build it by yourself.

* [http://susestudio.com/a/e0uuBG/meego-obs-light OBS Light appliance], built thanks to Suse studio

* [[OBS Light Installation | Uptodate Build]] for various Linux Distros.

* Videos training and intro [http://www.dailymotion.com/playlist/x1t5ll_dominigarfoll_obs-light-training Starting with OBS Light]

= Where is the information about OBS Light? =
* [[OBS_Light_Manual | OBS Light manual]]
* [[OBS_Light_FAQ | Frequently Asked Questions]]
* You can file bugs on [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light MeeGo's bugzilla]. The bug list for the project can be reached [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light here]. To easily file a new bug, use [https://bugs.meego.com/enter_bug.cgi?product=Development%20Tools this link]

All discussions are run on the MeeGo-distribution-tools mailing list.
http://lists.meego.com/listinfo/meego-distribution-tools

= Where can I find a private OBS appliance? =
You can find a OBS appliance, build in [http://susestudio.com suse studio]:
http://susegallery.com/a/e0uuBG/meego-obs

For more information about private OBS: http://en.opensuse.org/openSUSE:Build_Service_private_instance

You can Download the boot strap of Meego 1.2.0 here (saveOBS.tar.aa -> saveOBS.tar.ba).
http://www.cc-e.co.uk/Meego/MeeGo-1.2.0/
reassembled the file
cat saveOBS.tar.?? >> saveOBS.tar.gz
Thanks to Julien Snell and Cocom for the ftp server.
http://www.cc-e.co.uk

= What difference between OBS and OBS Light? =
OBS Light use an OBS server.
{|
| || '''OBS Light''' || '''Full OBS'''
|-
| Cross compilation || Yes || Yes
|-
| Local and remote reference || Yes || Yes
|-
| Automatic creation of patch || Yes || Not Yet (will if the same osc plugin is loaded)
|-
| Bootable Image creation || Yes || Add on
|-
| Integrated version control || Hidden || Yes
|-
| Multi-user || Hidden || Yes
|-
| Multi-target by project || Hidden || Yes
|-
| Auto built || Hidden || Yes
|-
| Signing service || Hidden || Yes
|}

Initial Specifications (final implementation have differed from the initial concept) :[[https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/Doc/SpecOBSLight-1_V-0-6.pdf SpecOBSLight-1_V-0-6]]

= Where is the OBS Light code? =
GIT: https://meego.gitorious.org/meego-developer-tools/obs-light

OBS: https://build.pub.meego.com/project/show?project=Project%3AOBS_Light

OBS Light

2012-04-02T15:31:23Z

Dominig: /* How to test or download OBS Light? */

[[File:OBSLightWiki.png‎ ]]
[http://blynt.canalblog.com/ Blynt]

= Why should I use OBS Light ?=
* I want to create a [https://meego.com/ MeeGo-based] distribution for my target ([https://meego.com/devices/smart-tv Smart TV], [https://meego.com/devices/in-vehicle In-Vehicle], [https://meego.com/devices/media-phone Media phone], [https://meego.com/devices/netbook Netbook], [https://meego.com/devices/handset Handset] ...).
* I want to include private code into my [https://meego.com/ MeeGo-based] distribution.
* I want to be fast from the beginning of my project to the first boot of my target.
* I want to use the same tools throughout my development cycle.

= Why not use OBS Light ?=
OBS Light is targeting the development of variants of MeeGo distribution (or any OBS build distro) to either add extra features to a MeeGo product or adapt a MeeGo distribution to different hardware configurations.
It is not an another SDK, if you want to develop applications for a MeeGo product you should have a look at the [https://meego.com/developers MeeGo SDK] which likely will better fit your need.

= What is OBS Light ?=
The project 'OBS Light' (or also obslight) , creates an encapsulation of OBS which presents a lighter face of OBS that we have called OBS light which could be delivered (if desired) with a pre-packaged MeeGo TV stack (or any other MeeGo vertical) released on a DVD image. The name was chosen to express that it remains an OBS base development process, but which is lighter to use, the idea of seeing the project as a light to guide the user in the flow of tools such as OBS, OSC, MIC, ... only came later. Once you will also see it incorrectly spell as 'OBS Lite'.

If you have (or are thinking about) selecting MeeGo but you cannot put all the code you want to build on OBS, the public, cloud-based MeeGo building tool, or if you are more comfortable with the tradition of local build tools based on a chroot than with a full cloud-based system like OBS, you might find the learning curve a bit steep.

While OBS will provide you with a very powerful and adapted tool for your long-term needs, the entry cost can be perceived to be too high.
This issue is particularly strongly perceived in the TV or IVI segments where recompilation of the Linux kernel and adding drivers is required even during the very early phases of a project and compiling in the public domain is out of the question.

In a second phase we hope to add a simple UI to it. It reuses the osc command line tools delivered with OBS to which a set of extra plugins have been added, including an extension of mic. All this remains compatible with a full implementation of OBS. It will be published under License: GPLv2.

The osc plugin for automatic patch creation are designed to be reusable in a full OBS environment.

The coding is under work and changes are likely to occur during the development process.

Note that under the hood, OBS light still is 100% OBS code and the building process is the same as what you could achieve by running your own private OBS.
OBS Light mainly pre-configures an OBS with a few osc plugins to ease the learning curve.

Note that some OBS feature are hidden to simplify the learning phase. As the service is run locally, you can mix Open Source and private code should you need to do so.

= Download OBS Light? =

OBS Light is available either as a ready to run appliance to execute as a virtual machine, ready made packages for common distros and obsviously as source file to build it by yourself.

* [http://susestudio.com/a/e0uuBG/meego-obs-light OBS Light appliance], built thanks to Suse studio

* [[OBS Light Installation | Uptodate Build]] for various Linux Distros.

* Videos training and intro [http://www.dailymotion.com/playlist/x1t5ll_dominigarfoll_obs-light-training Starting with OBS Light]

= Where is the information about OBS Light? =
* [[OBS_Light_Manual | OBS Light manual]]
* [[OBS_Light_FAQ | Frequently Asked Questions]]
* You can file bugs on [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light MeeGo's bugzilla]. The bug list for the project can be reached [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light here]. To easily file a new bug, use [https://bugs.meego.com/enter_bug.cgi?product=Development%20Tools this link]

All discussions are run on the MeeGo-distribution-tools mailing list.
http://lists.meego.com/listinfo/meego-distribution-tools

= Where can I find a private OBS appliance? =
You can find a OBS appliance, build in [http://susestudio.com suse studio]:
http://susegallery.com/a/e0uuBG/meego-obs

For more information about private OBS: http://en.opensuse.org/openSUSE:Build_Service_private_instance

You can Download the boot strap of Meego 1.2.0 here (saveOBS.tar.aa -> saveOBS.tar.ba).
http://www.cc-e.co.uk/Meego/MeeGo-1.2.0/
reassembled the file
cat saveOBS.tar.?? >> saveOBS.tar.gz
Thanks to Julien Snell and Cocom for the ftp server.
http://www.cc-e.co.uk

= What difference between OBS and OBS Light? =
OBS Light use an OBS server.
{|
| || '''OBS Light''' || '''Full OBS'''
|-
| Cross compilation || Yes || Yes
|-
| Local and remote reference || Yes || Yes
|-
| Automatic creation of patch || Yes || Not Yet (will if the same osc plugin is loaded)
|-
| Bootable Image creation || Yes || Add on
|-
| Integrated version control || Hidden || Yes
|-
| Multi-user || Hidden || Yes
|-
| Multi-target by project || Hidden || Yes
|-
| Auto built || Hidden || Yes
|-
| Signing service || Hidden || Yes
|}

Initial Specifications (final implementation have differed from the initial concept) :[[https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/Doc/SpecOBSLight-1_V-0-6.pdf SpecOBSLight-1_V-0-6]]

= Where is the OBS Light code? =
GIT: https://meego.gitorious.org/meego-developer-tools/obs-light

OBS: https://build.pub.meego.com/project/show?project=Project%3AOBS_Light

OBS Light

2012-04-02T15:31:00Z

Dominig: /* How to test or use OBS Light? */

[[File:OBSLightWiki.png‎ ]]
[http://blynt.canalblog.com/ Blynt]

= Why should I use OBS Light ?=
* I want to create a [https://meego.com/ MeeGo-based] distribution for my target ([https://meego.com/devices/smart-tv Smart TV], [https://meego.com/devices/in-vehicle In-Vehicle], [https://meego.com/devices/media-phone Media phone], [https://meego.com/devices/netbook Netbook], [https://meego.com/devices/handset Handset] ...).
* I want to include private code into my [https://meego.com/ MeeGo-based] distribution.
* I want to be fast from the beginning of my project to the first boot of my target.
* I want to use the same tools throughout my development cycle.

= Why not use OBS Light ?=
OBS Light is targeting the development of variants of MeeGo distribution (or any OBS build distro) to either add extra features to a MeeGo product or adapt a MeeGo distribution to different hardware configurations.
It is not an another SDK, if you want to develop applications for a MeeGo product you should have a look at the [https://meego.com/developers MeeGo SDK] which likely will better fit your need.

= What is OBS Light ?=
The project 'OBS Light' (or also obslight) , creates an encapsulation of OBS which presents a lighter face of OBS that we have called OBS light which could be delivered (if desired) with a pre-packaged MeeGo TV stack (or any other MeeGo vertical) released on a DVD image. The name was chosen to express that it remains an OBS base development process, but which is lighter to use, the idea of seeing the project as a light to guide the user in the flow of tools such as OBS, OSC, MIC, ... only came later. Once you will also see it incorrectly spell as 'OBS Lite'.

If you have (or are thinking about) selecting MeeGo but you cannot put all the code you want to build on OBS, the public, cloud-based MeeGo building tool, or if you are more comfortable with the tradition of local build tools based on a chroot than with a full cloud-based system like OBS, you might find the learning curve a bit steep.

While OBS will provide you with a very powerful and adapted tool for your long-term needs, the entry cost can be perceived to be too high.
This issue is particularly strongly perceived in the TV or IVI segments where recompilation of the Linux kernel and adding drivers is required even during the very early phases of a project and compiling in the public domain is out of the question.

In a second phase we hope to add a simple UI to it. It reuses the osc command line tools delivered with OBS to which a set of extra plugins have been added, including an extension of mic. All this remains compatible with a full implementation of OBS. It will be published under License: GPLv2.

The osc plugin for automatic patch creation are designed to be reusable in a full OBS environment.

The coding is under work and changes are likely to occur during the development process.

Note that under the hood, OBS light still is 100% OBS code and the building process is the same as what you could achieve by running your own private OBS.
OBS Light mainly pre-configures an OBS with a few osc plugins to ease the learning curve.

Note that some OBS feature are hidden to simplify the learning phase. As the service is run locally, you can mix Open Source and private code should you need to do so.

= How to test or download OBS Light? =

OBS Light is available either as a ready to run appliance to execute as a virtual machine, ready made packages for common distros and obsviously as source file to build it by yourself.

* [http://susestudio.com/a/e0uuBG/meego-obs-light OBS Light appliance], built thanks to Suse studio

* [[OBS Light Installation | Uptodate Build]] for various Linux Distros.

* Videos training and intro [http://www.dailymotion.com/playlist/x1t5ll_dominigarfoll_obs-light-training Starting with OBS Light]

= Where is the information about OBS Light? =
* [[OBS_Light_Manual | OBS Light manual]]
* [[OBS_Light_FAQ | Frequently Asked Questions]]
* You can file bugs on [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light MeeGo's bugzilla]. The bug list for the project can be reached [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light here]. To easily file a new bug, use [https://bugs.meego.com/enter_bug.cgi?product=Development%20Tools this link]

All discussions are run on the MeeGo-distribution-tools mailing list.
http://lists.meego.com/listinfo/meego-distribution-tools

= Where can I find a private OBS appliance? =
You can find a OBS appliance, build in [http://susestudio.com suse studio]:
http://susegallery.com/a/e0uuBG/meego-obs

For more information about private OBS: http://en.opensuse.org/openSUSE:Build_Service_private_instance

You can Download the boot strap of Meego 1.2.0 here (saveOBS.tar.aa -> saveOBS.tar.ba).
http://www.cc-e.co.uk/Meego/MeeGo-1.2.0/
reassembled the file
cat saveOBS.tar.?? >> saveOBS.tar.gz
Thanks to Julien Snell and Cocom for the ftp server.
http://www.cc-e.co.uk

= What difference between OBS and OBS Light? =
OBS Light use an OBS server.
{|
| || '''OBS Light''' || '''Full OBS'''
|-
| Cross compilation || Yes || Yes
|-
| Local and remote reference || Yes || Yes
|-
| Automatic creation of patch || Yes || Not Yet (will if the same osc plugin is loaded)
|-
| Bootable Image creation || Yes || Add on
|-
| Integrated version control || Hidden || Yes
|-
| Multi-user || Hidden || Yes
|-
| Multi-target by project || Hidden || Yes
|-
| Auto built || Hidden || Yes
|-
| Signing service || Hidden || Yes
|}

Initial Specifications (final implementation have differed from the initial concept) :[[https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/Doc/SpecOBSLight-1_V-0-6.pdf SpecOBSLight-1_V-0-6]]

= Where is the OBS Light code? =
GIT: https://meego.gitorious.org/meego-developer-tools/obs-light

OBS: https://build.pub.meego.com/project/show?project=Project%3AOBS_Light

OBS Light Installation

2012-03-20T11:38:27Z

Dominig: /* For OpenSUSE 12.1 */

= OBS Light Deliverable =
== Introduction ==
[[OBS Light]] project deliverable which are available are listed on this page. Publication of the information will follow the progress of the implementation (yes, we do publish early draft versions, using them is at your risk)

== Packaged versions ==
Packaged versions of the OBS Light client (still in development) are available for OpenSUSE, MeeGo, Debian and Ubuntu.
=== For OpenSUSE 11.4 ===
The repository is [http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_11.4/ here].
There are 2 packages:
* ''obslight'', which contains the API, a commandline client, and [[obstag | obstag, obs2obscopy and obsextractgroups]]
* ''obslight-gui'', which contains the graphical user interface
To install ''obslight'':
zypper ar -f http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_11.4/ OBS_Light
optional, to disable GPG checks and prevent "File 'repomd.xml' from repository 'OBS_Light' is unsigned" messages
echo "gpgcheck=0" >> /etc/zypp/repos.d/OBS_Light.repo
zypper --gpg-auto-import-keys ref
zypper in obslight
To install the GUI, you will need PySide:
zypper ar http://download.opensuse.org/repositories/home:/cgoncalves:/pyside:/shiboken/openSUSE_11.4/ pyside
zypper --gpg-auto-import-keys ref
zypper in obslight-gui

=== For OpenSUSE 12.1 ===
There are 2 packages:
* ''obslight'', which contains the API, a commandline client, and [[obstag | obstag, obs2obscopy and obsextractgroups]]
* ''obslight-gui'', which contains the graphical user interface
zypper ar http://repo.pub.meego.com/Project:/OBS_Light:/openSUSE:/12.1/openSUSE_12.1/Project:OBS_Light:openSUSE:12.1.repo OBS_Light
optional, to disable GPG checks and prevent "File 'repomd.xml' from repository 'OBS_Light' is unsigned" messages
echo "gpgcheck=0" >> "/etc/zypp/repos.d/OBS_Light.repo"

To install the GUI, you will need PySide:
zypper ar http://download.opensuse.org/repositories/home:/Fisiu:/pyside/openSUSE_12.1/home:Fisiu:pyside.repo Pyside
zypper --gpg-auto-import-keys ref

zypper in obslight obslight-gui

=== For Ubuntu ===
The repositories are [http://repo.pub.meego.com/Project:/OBS_Light/ here]. Available Ubuntu versions are '''10.04''', '''11.04''' and '''11.10'''.
There is only one package, ''obslight'', which contains the commandline, the GUI and the utilities. Add the following line to your '''/etc/apt/sources.list''' file (or to a new file '''/etc/apt/sources.list.d/obslight.list'''), replacing '''<version>''' by the appropriate version:
deb http://repo.pub.meego.com/Project:/OBS_Light/Ubuntu_<version>/ ./
You also need a recent version of [http://www.pyside.org/ PySide]:
sudo apt-add-repository ppa:pyside/ppa
If you have Ubuntu 10.04 and an old version of '''osc''' (< 0.132) we suggest also adding:
deb http://download.opensuse.org/repositories/openSUSE:/Tools/xUbuntu_10.04/ ./
Refresh the APT database and install OBS Light:
sudo apt-get update
sudo apt-get install obslight
Add yourself to the '''users''' group:
sudo usermod -a -G users `whoami`
You should log out so that the system takes into account your new group.
If you don't want to log out, you can use "''newgrp users''" before running obslight (but it will only work in the current console).

=== For Debian ===
[''Not tested'']
The repository is [http://repo.pub.meego.com/home:/ronan:/OBS_Light/Debian_6.0/ here].

''Note'': the '''obslight''' package has a dependency to [http://www.pyside.org/ PySide], which is not included in Debian "stable". So you will need Debian "testing" if you want to test.

== Usage ==
To get a brief overview of all available commands, just type:
obslight --help

== OBS Tagging and Project copying ==
One of the problem that any user of a private OBS will quickly face, is the need to tag specific version of a project and allow the copy of the project from an OBS to an other OBS or from one project to an other project.

More details on obstag and obs2obscopy can be found [[obstag | here]]

= Links =
* [[OBS Light | OBS Light main page]]
* [[OBS_Light_FAQ | OBS Light Frequently Asked Questions]]
* [[OBS_Light_Manual | OBS Light Manual]]
* [https://meego.gitorious.org/meego-developer-tools/obs-light/ OBS Light project on Gitorious]
* [https://build.pub.meego.com/project/show?project=Project%3AOBS_Light OBS Light project on MeeGo build service]

OBS Light Installation

2012-03-20T11:17:13Z

Dominig: /* For OpenSUSE 12.1 */

= OBS Light Deliverable =
== Introduction ==
[[OBS Light]] project deliverable which are available are listed on this page. Publication of the information will follow the progress of the implementation (yes, we do publish early draft versions, using them is at your risk)

== Packaged versions ==
Packaged versions of the OBS Light client (still in development) are available for OpenSUSE, MeeGo, Debian and Ubuntu.
=== For OpenSUSE 11.4 ===
The repository is [http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_11.4/ here].
There are 2 packages:
* ''obslight'', which contains the API, a commandline client, and [[obstag | obstag, obs2obscopy and obsextractgroups]]
* ''obslight-gui'', which contains the graphical user interface
To install ''obslight'':
zypper ar -f http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_11.4/ OBS_Light
optional, to disable GPG checks and prevent "File 'repomd.xml' from repository 'OBS_Light' is unsigned" messages
echo "gpgcheck=0" >> /etc/zypp/repos.d/OBS_Light.repo
zypper --gpg-auto-import-keys ref
zypper in obslight
To install the GUI, you will need PySide:
zypper ar http://download.opensuse.org/repositories/home:/cgoncalves:/pyside:/shiboken/openSUSE_11.4/ pyside
zypper --gpg-auto-import-keys ref
zypper in obslight-gui

=== For OpenSUSE 12.1 ===
There are 2 packages:
* ''obslight'', which contains the API, a commandline client, and [[obstag | obstag, obs2obscopy and obsextractgroups]]
* ''obslight-gui'', which contains the graphical user interface
zypper ar http://repo.pub.meego.com/Project:/OBS_Light:/openSUSE:/12.1/openSUSE_12.1/Project:OBS_Light:openSUSE:12.1.repo Project_OBS_Light
optional, to disable GPG checks and prevent "File 'repomd.xml' from repository 'OBS_Light' is unsigned" messages
echo "gpgcheck=0" >> /etc/zypp/repos.d/Project_OBS_Light.repo

To install the GUI, you will need PySide:
zypper ar http://download.opensuse.org/repositories/home:/Fisiu:/pyside/openSUSE_12.1/home:Fisiu:pyside.repo pyside
zypper --gpg-auto-import-keys ref

zypper in obslight obslight-gui

=== For Ubuntu ===
The repositories are [http://repo.pub.meego.com/Project:/OBS_Light/ here]. Available Ubuntu versions are '''10.04''', '''11.04''' and '''11.10'''.
There is only one package, ''obslight'', which contains the commandline, the GUI and the utilities. Add the following line to your '''/etc/apt/sources.list''' file (or to a new file '''/etc/apt/sources.list.d/obslight.list'''), replacing '''<version>''' by the appropriate version:
deb http://repo.pub.meego.com/Project:/OBS_Light/Ubuntu_<version>/ ./
You also need a recent version of [http://www.pyside.org/ PySide]:
sudo apt-add-repository ppa:pyside/ppa
If you have Ubuntu 10.04 and an old version of '''osc''' (< 0.132) we suggest also adding:
deb http://download.opensuse.org/repositories/openSUSE:/Tools/xUbuntu_10.04/ ./
Refresh the APT database and install OBS Light:
sudo apt-get update
sudo apt-get install obslight
Add yourself to the '''users''' group:
sudo usermod -a -G users `whoami`
You should log out so that the system takes into account your new group.
If you don't want to log out, you can use "''newgrp users''" before running obslight (but it will only work in the current console).

=== For Debian ===
[''Not tested'']
The repository is [http://repo.pub.meego.com/home:/ronan:/OBS_Light/Debian_6.0/ here].

''Note'': the '''obslight''' package has a dependency to [http://www.pyside.org/ PySide], which is not included in Debian "stable". So you will need Debian "testing" if you want to test.

== Usage ==
To get a brief overview of all available commands, just type:
obslight --help

== OBS Tagging and Project copying ==
One of the problem that any user of a private OBS will quickly face, is the need to tag specific version of a project and allow the copy of the project from an OBS to an other OBS or from one project to an other project.

More details on obstag and obs2obscopy can be found [[obstag | here]]

= Links =
* [[OBS Light | OBS Light main page]]
* [[OBS_Light_FAQ | OBS Light Frequently Asked Questions]]
* [[OBS_Light_Manual | OBS Light Manual]]
* [https://meego.gitorious.org/meego-developer-tools/obs-light/ OBS Light project on Gitorious]
* [https://build.pub.meego.com/project/show?project=Project%3AOBS_Light OBS Light project on MeeGo build service]

OBS Light

2012-03-19T08:49:32Z

Dominig: /* What is OBS Light ? */

[[File:OBSLightWiki.png‎ ]]
[http://blynt.canalblog.com/ Blynt]

= Why should I use OBS Light ?=
* I want to create a [https://meego.com/ MeeGo-based] distribution for my target ([https://meego.com/devices/smart-tv Smart TV], [https://meego.com/devices/in-vehicle In-Vehicle], [https://meego.com/devices/media-phone Media phone], [https://meego.com/devices/netbook Netbook], [https://meego.com/devices/handset Handset] ...).
* I want to include private code into my [https://meego.com/ MeeGo-based] distribution.
* I want to be fast from the beginning of my project to the first boot of my target.
* I want to use the same tools throughout my development cycle.

= Why not use OBS Light ?=
OBS Light is targeting the development of variants of MeeGo distribution (or any OBS build distro) to either add extra features to a MeeGo product or adapt a MeeGo distribution to different hardware configurations.
It is not an another SDK, if you want to develop applications for a MeeGo product you should have a look at the [https://meego.com/developers MeeGo SDK] which likely will better fit your need.

= What is OBS Light ?=
The project 'OBS Light' (or also obslight) , creates an encapsulation of OBS which presents a lighter face of OBS that we have called OBS light which could be delivered (if desired) with a pre-packaged MeeGo TV stack (or any other MeeGo vertical) released on a DVD image. The name was chosen to express that it remains an OBS base development process, but which is lighter to use, the idea of seeing the project as a light to guide the user in the flow of tools such as OBS, OSC, MIC, ... only came later. Once you will also see it incorrectly spell as 'OBS Lite'.

If you have (or are thinking about) selecting MeeGo but you cannot put all the code you want to build on OBS, the public, cloud-based MeeGo building tool, or if you are more comfortable with the tradition of local build tools based on a chroot than with a full cloud-based system like OBS, you might find the learning curve a bit steep.

While OBS will provide you with a very powerful and adapted tool for your long-term needs, the entry cost can be perceived to be too high.
This issue is particularly strongly perceived in the TV or IVI segments where recompilation of the Linux kernel and adding drivers is required even during the very early phases of a project and compiling in the public domain is out of the question.

In a second phase we hope to add a simple UI to it. It reuses the osc command line tools delivered with OBS to which a set of extra plugins have been added, including an extension of mic. All this remains compatible with a full implementation of OBS. It will be published under License: GPLv2.

The osc plugin for automatic patch creation are designed to be reusable in a full OBS environment.

The coding is under work and changes are likely to occur during the development process.

Note that under the hood, OBS light still is 100% OBS code and the building process is the same as what you could achieve by running your own private OBS.
OBS Light mainly pre-configures an OBS with a few osc plugins to ease the learning curve.

Note that some OBS feature are hidden to simplify the learning phase. As the service is run locally, you can mix Open Source and private code should you need to do so.

= How to test or use OBS Light? =
You can find a OBS Light appliance, build in [http://susestudio.com suse studio]:
http://susestudio.com/a/e0uuBG/meego-obs-light

* uptodate Build for various distros can be found in the [[ObsLightDeliverable]] page.

* Videos training and intro [http://www.dailymotion.com/playlist/x1t5ll_dominigarfoll_obs-light-training Starting with OBS Light]

= Where is the information about OBS Light? =
* [[OBS_Light_Manual | OBS Light manual]]
* [[OBS_Light_FAQ | Frequently Asked Questions]]
* You can file bugs on [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light MeeGo's bugzilla]. The bug list for the project can be reached [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light here]. To easily file a new bug, use [https://bugs.meego.com/enter_bug.cgi?product=Development%20Tools this link]

All discussions are run on the MeeGo-distribution-tools mailing list.
http://lists.meego.com/listinfo/meego-distribution-tools

= Where can I find a private OBS appliance? =
You can find a OBS appliance, build in [http://susestudio.com suse studio]:
http://susegallery.com/a/e0uuBG/meego-obs

For more information about private OBS: http://en.opensuse.org/openSUSE:Build_Service_private_instance

You can Download the boot strap of Meego 1.2.0 here (saveOBS.tar.aa -> saveOBS.tar.ba).
http://www.cc-e.co.uk/Meego/MeeGo-1.2.0/
reassembled the file
cat saveOBS.tar.?? >> saveOBS.tar.gz
Thanks to Julien Snell and Cocom for the ftp server.
http://www.cc-e.co.uk

= What difference between OBS and OBS Light? =
OBS Light use an OBS server.
{|
| || '''OBS Light''' || '''Full OBS'''
|-
| Cross compilation || Yes || Yes
|-
| Local and remote reference || Yes || Yes
|-
| Automatic creation of patch || Yes || Not Yet (will if the same osc plugin is loaded)
|-
| Bootable Image creation || Yes || Add on
|-
| Integrated version control || Hidden || Yes
|-
| Multi-user || Hidden || Yes
|-
| Multi-target by project || Hidden || Yes
|-
| Auto built || Hidden || Yes
|-
| Signing service || Hidden || Yes
|}

Initial Specifications (final implementation have differed from the initial concept) :[[https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/Doc/SpecOBSLight-1_V-0-6.pdf SpecOBSLight-1_V-0-6]]

= Where is the OBS Light code? =
GIT: https://meego.gitorious.org/meego-developer-tools/obs-light

OBS: https://build.pub.meego.com/project/show?project=Project%3AOBS_Light

OBS Light

2012-03-02T18:27:25Z

Dominig: /* What difference between OBS and OBS Light? */

[[File:OBSLightWiki.png‎ ]]
[http://blynt.canalblog.com/ Blynt]

= Why should I use OBS Light ?=
* I want to create a [https://meego.com/ MeeGo-based] distribution for my target ([https://meego.com/devices/smart-tv Smart TV], [https://meego.com/devices/in-vehicle In-Vehicle], [https://meego.com/devices/media-phone Media phone], [https://meego.com/devices/netbook Netbook], [https://meego.com/devices/handset Handset] ...).
* I want to include private code into my [https://meego.com/ MeeGo-based] distribution.
* I want to be fast from the beginning of my project to the first boot of my target.
* I want to use the same tools throughout my development cycle.

= Why not use OBS Light ?=
OBS Light is targeting the development of variants of MeeGo distribution (or any OBS build distro) to either add extra features to a MeeGo product or adapt a MeeGo distribution to different hardware configurations.
It is not an another SDK, if you want to develop applications for a MeeGo product you should have a look at the [https://meego.com/developers MeeGo SDK] which likely will better fit your need.

= What is OBS Light ?=
The project 'OBS Light' (or also obslight) , creates an encapsulation of OBS which presents a lighter face of OBS that we have called OBS light which could be delivered (if desired) with a pre-packaged MeeGo TV stack (or any other MeeGo vertical) released on a DVD image.

If you have (or are thinking about) selecting MeeGo but you cannot put all the code you want to build on OBS, the public, cloud-based MeeGo building tool, or if you are more comfortable with the tradition of local build tools based on a chroot than with a full cloud-based system like OBS, you might find the learning curve a bit steep.

While OBS will provide you with a very powerful and adapted tool for your long-term needs, the entry cost can be perceived to be too high.
This issue is particularly strongly perceived in the TV or IVI segments where recompilation of the Linux kernel and adding drivers is required even during the very early phases of a project and compiling in the public domain is out of the question.

In a second phase we hope to add a simple UI to it. It reuses the osc command line tools delivered with OBS to which a set of extra plugins have been added, including an extension of mic. All this remains compatible with a full implementation of OBS. It will be published under License: GPLv2.

The osc plugin for automatic patch creation are designed to be reusable in a full OBS environment.

The coding is under work and changes are likely to occur during the development process.

Note that under the hood, OBS light still is 100% OBS code and the building process is the same as what you could achieve by running your own private OBS.
OBS Light mainly pre-configures an OBS with a few osc plugins to ease the learning curve.

Note that some OBS feature are hidden to simplify the learning phase. As the service is run locally, you can mix Open Source and private code should you need to do so.

= How to test or use OBS Light? =
You can find a OBS Light appliance, build in [http://susestudio.com suse studio]:
http://susestudio.com/a/e0uuBG/meego-obs-light

* uptodate Build for various distros can be found in the [[ObsLightDeliverable]] page.

* Videos training and intro [http://www.dailymotion.com/playlist/x1t5ll_dominigarfoll_obs-light-training Starting with OBS Light]

= Where is the information about OBS Light? =
* [[OBS_Light_Manual | OBS Light manual]]
* [[OBS_Light_FAQ | Frequently Asked Questions]]
* You can file bugs on [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light MeeGo's bugzilla]. The bug list for the project can be reached [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light here]. To easily file a new bug, use [https://bugs.meego.com/enter_bug.cgi?product=Development%20Tools this link]

All discussions are run on the MeeGo-distribution-tools mailing list.
http://lists.meego.com/listinfo/meego-distribution-tools

= Where can I find a private OBS appliance? =
You can find a OBS appliance, build in [http://susestudio.com suse studio]:
http://susegallery.com/a/e0uuBG/meego-obs

For more information about private OBS: http://en.opensuse.org/openSUSE:Build_Service_private_instance

You can Download the boot strap of Meego 1.2.0 here (saveOBS.tar.aa -> saveOBS.tar.ba).
http://www.cc-e.co.uk/Meego/MeeGo-1.2.0/
reassembled the file
cat saveOBS.tar.?? >> saveOBS.tar.gz
Thanks to Julien Snell and Cocom for the ftp server.
http://www.cc-e.co.uk

= What difference between OBS and OBS Light? =
OBS Light use an OBS server.
{|
| || '''OBS Light''' || '''Full OBS'''
|-
| Cross compilation || Yes || Yes
|-
| Local and remote reference || Yes || Yes
|-
| Automatic creation of patch || Yes || Not Yet (will if the same osc plugin is loaded)
|-
| Bootable Image creation || Yes || Add on
|-
| Integrated version control || Hidden || Yes
|-
| Multi-user || Hidden || Yes
|-
| Multi-target by project || Hidden || Yes
|-
| Auto built || Hidden || Yes
|-
| Signing service || Hidden || Yes
|}

Initial Specifications (final implementation have differed from the initial concept) :[[https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/Doc/SpecOBSLight-1_V-0-6.pdf SpecOBSLight-1_V-0-6]]

= Where is the OBS Light code? =
GIT: https://meego.gitorious.org/meego-developer-tools/obs-light

OBS: https://build.pub.meego.com/project/show?project=Project%3AOBS_Light

OBS Light

2012-03-02T18:26:41Z

Dominig: /* How to test or use OBS Light? */

[[File:OBSLightWiki.png‎ ]]
[http://blynt.canalblog.com/ Blynt]

= Why should I use OBS Light ?=
* I want to create a [https://meego.com/ MeeGo-based] distribution for my target ([https://meego.com/devices/smart-tv Smart TV], [https://meego.com/devices/in-vehicle In-Vehicle], [https://meego.com/devices/media-phone Media phone], [https://meego.com/devices/netbook Netbook], [https://meego.com/devices/handset Handset] ...).
* I want to include private code into my [https://meego.com/ MeeGo-based] distribution.
* I want to be fast from the beginning of my project to the first boot of my target.
* I want to use the same tools throughout my development cycle.

= Why not use OBS Light ?=
OBS Light is targeting the development of variants of MeeGo distribution (or any OBS build distro) to either add extra features to a MeeGo product or adapt a MeeGo distribution to different hardware configurations.
It is not an another SDK, if you want to develop applications for a MeeGo product you should have a look at the [https://meego.com/developers MeeGo SDK] which likely will better fit your need.

= What is OBS Light ?=
The project 'OBS Light' (or also obslight) , creates an encapsulation of OBS which presents a lighter face of OBS that we have called OBS light which could be delivered (if desired) with a pre-packaged MeeGo TV stack (or any other MeeGo vertical) released on a DVD image.

If you have (or are thinking about) selecting MeeGo but you cannot put all the code you want to build on OBS, the public, cloud-based MeeGo building tool, or if you are more comfortable with the tradition of local build tools based on a chroot than with a full cloud-based system like OBS, you might find the learning curve a bit steep.

While OBS will provide you with a very powerful and adapted tool for your long-term needs, the entry cost can be perceived to be too high.
This issue is particularly strongly perceived in the TV or IVI segments where recompilation of the Linux kernel and adding drivers is required even during the very early phases of a project and compiling in the public domain is out of the question.

In a second phase we hope to add a simple UI to it. It reuses the osc command line tools delivered with OBS to which a set of extra plugins have been added, including an extension of mic. All this remains compatible with a full implementation of OBS. It will be published under License: GPLv2.

The osc plugin for automatic patch creation are designed to be reusable in a full OBS environment.

The coding is under work and changes are likely to occur during the development process.

Note that under the hood, OBS light still is 100% OBS code and the building process is the same as what you could achieve by running your own private OBS.
OBS Light mainly pre-configures an OBS with a few osc plugins to ease the learning curve.

Note that some OBS feature are hidden to simplify the learning phase. As the service is run locally, you can mix Open Source and private code should you need to do so.

= How to test or use OBS Light? =
You can find a OBS Light appliance, build in [http://susestudio.com suse studio]:
http://susestudio.com/a/e0uuBG/meego-obs-light

* uptodate Build for various distros can be found in the [[ObsLightDeliverable]] page.

* Videos training and intro [http://www.dailymotion.com/playlist/x1t5ll_dominigarfoll_obs-light-training Starting with OBS Light]

= Where is the information about OBS Light? =
* [[OBS_Light_Manual | OBS Light manual]]
* [[OBS_Light_FAQ | Frequently Asked Questions]]
* You can file bugs on [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light MeeGo's bugzilla]. The bug list for the project can be reached [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light here]. To easily file a new bug, use [https://bugs.meego.com/enter_bug.cgi?product=Development%20Tools this link]

All discussions are run on the MeeGo-distribution-tools mailing list.
http://lists.meego.com/listinfo/meego-distribution-tools

= Where can I find a private OBS appliance? =
You can find a OBS appliance, build in [http://susestudio.com suse studio]:
http://susegallery.com/a/e0uuBG/meego-obs

For more information about private OBS: http://en.opensuse.org/openSUSE:Build_Service_private_instance

You can Download the boot strap of Meego 1.2.0 here (saveOBS.tar.aa -> saveOBS.tar.ba).
http://www.cc-e.co.uk/Meego/MeeGo-1.2.0/
reassembled the file
cat saveOBS.tar.?? >> saveOBS.tar.gz
Thanks to Julien Snell and Cocom for the ftp server.
http://www.cc-e.co.uk

= What difference between OBS and OBS Light? =
OBS Light use an OBS server.
{|
| || '''OBS Light''' || '''Full OBS'''
|-
| Cross compilation || Yes || Yes
|-
| Local and remote reference || Yes || Yes
|-
| Automatic creation of patch || Yes || Not Yet (will if the same osc plugin is loaded)
|-
| Bootable Image creation || Yes || Add on
|-
| Integrated version control || Hidden || Yes
|-
| Multi-user || Hidden || Yes
|-
| Multi-target by project || Hidden || Yes
|-
| Auto built || Hidden || Yes
|-
| Signing service || Hidden || Yes
|}

Initial Specifications (final implementation are likely differ from the initial concept) :[[https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/Doc/SpecOBSLight-1_V-0-6.pdf SpecOBSLight-1_V-0-6]]

= Where is the OBS Light code? =
GIT: https://meego.gitorious.org/meego-developer-tools/obs-light

OBS: https://build.pub.meego.com/project/show?project=Project%3AOBS_Light

OBS Light

2012-03-02T18:24:51Z

Dominig: /* Why not use OBS Light ? */

[[File:OBSLightWiki.png‎ ]]
[http://blynt.canalblog.com/ Blynt]

= Why should I use OBS Light ?=
* I want to create a [https://meego.com/ MeeGo-based] distribution for my target ([https://meego.com/devices/smart-tv Smart TV], [https://meego.com/devices/in-vehicle In-Vehicle], [https://meego.com/devices/media-phone Media phone], [https://meego.com/devices/netbook Netbook], [https://meego.com/devices/handset Handset] ...).
* I want to include private code into my [https://meego.com/ MeeGo-based] distribution.
* I want to be fast from the beginning of my project to the first boot of my target.
* I want to use the same tools throughout my development cycle.

= Why not use OBS Light ?=
OBS Light is targeting the development of variants of MeeGo distribution (or any OBS build distro) to either add extra features to a MeeGo product or adapt a MeeGo distribution to different hardware configurations.
It is not an another SDK, if you want to develop applications for a MeeGo product you should have a look at the [https://meego.com/developers MeeGo SDK] which likely will better fit your need.

= What is OBS Light ?=
The project 'OBS Light' (or also obslight) , creates an encapsulation of OBS which presents a lighter face of OBS that we have called OBS light which could be delivered (if desired) with a pre-packaged MeeGo TV stack (or any other MeeGo vertical) released on a DVD image.

If you have (or are thinking about) selecting MeeGo but you cannot put all the code you want to build on OBS, the public, cloud-based MeeGo building tool, or if you are more comfortable with the tradition of local build tools based on a chroot than with a full cloud-based system like OBS, you might find the learning curve a bit steep.

While OBS will provide you with a very powerful and adapted tool for your long-term needs, the entry cost can be perceived to be too high.
This issue is particularly strongly perceived in the TV or IVI segments where recompilation of the Linux kernel and adding drivers is required even during the very early phases of a project and compiling in the public domain is out of the question.

In a second phase we hope to add a simple UI to it. It reuses the osc command line tools delivered with OBS to which a set of extra plugins have been added, including an extension of mic. All this remains compatible with a full implementation of OBS. It will be published under License: GPLv2.

The osc plugin for automatic patch creation are designed to be reusable in a full OBS environment.

The coding is under work and changes are likely to occur during the development process.

Note that under the hood, OBS light still is 100% OBS code and the building process is the same as what you could achieve by running your own private OBS.
OBS Light mainly pre-configures an OBS with a few osc plugins to ease the learning curve.

Note that some OBS feature are hidden to simplify the learning phase. As the service is run locally, you can mix Open Source and private code should you need to do so.

= How to test or use OBS Light? =
You can find a OBS Light appliance, build in [http://susestudio.com suse studio]:
http://susestudio.com/a/e0uuBG/meego-obs-light

* Current progress an deliveries can be found in [[ObsLightDeliverable]] page.

* Videos [http://www.dailymotion.com/playlist/x1t5ll_dominigarfoll_obs-light-training Starting with OBS Light]

= Where is the information about OBS Light? =
* [[OBS_Light_Manual | OBS Light manual]]
* [[OBS_Light_FAQ | Frequently Asked Questions]]
* You can file bugs on [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light MeeGo's bugzilla]. The bug list for the project can be reached [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light here]. To easily file a new bug, use [https://bugs.meego.com/enter_bug.cgi?product=Development%20Tools this link]

All discussions are run on the MeeGo-distribution-tools mailing list.
http://lists.meego.com/listinfo/meego-distribution-tools

= Where can I find a private OBS appliance? =
You can find a OBS appliance, build in [http://susestudio.com suse studio]:
http://susegallery.com/a/e0uuBG/meego-obs

For more information about private OBS: http://en.opensuse.org/openSUSE:Build_Service_private_instance

You can Download the boot strap of Meego 1.2.0 here (saveOBS.tar.aa -> saveOBS.tar.ba).
http://www.cc-e.co.uk/Meego/MeeGo-1.2.0/
reassembled the file
cat saveOBS.tar.?? >> saveOBS.tar.gz
Thanks to Julien Snell and Cocom for the ftp server.
http://www.cc-e.co.uk

= What difference between OBS and OBS Light? =
OBS Light use an OBS server.
{|
| || '''OBS Light''' || '''Full OBS'''
|-
| Cross compilation || Yes || Yes
|-
| Local and remote reference || Yes || Yes
|-
| Automatic creation of patch || Yes || Not Yet (will if the same osc plugin is loaded)
|-
| Bootable Image creation || Yes || Add on
|-
| Integrated version control || Hidden || Yes
|-
| Multi-user || Hidden || Yes
|-
| Multi-target by project || Hidden || Yes
|-
| Auto built || Hidden || Yes
|-
| Signing service || Hidden || Yes
|}

Initial Specifications (final implementation are likely differ from the initial concept) :[[https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/Doc/SpecOBSLight-1_V-0-6.pdf SpecOBSLight-1_V-0-6]]

= Where is the OBS Light code? =
GIT: https://meego.gitorious.org/meego-developer-tools/obs-light

OBS: https://build.pub.meego.com/project/show?project=Project%3AOBS_Light

OBS Light FAQ

2012-02-17T13:15:17Z

Dominig: /* How do I run OBS light server appliance on my Desktop ? */

= Frequently Asked Questions =
== Where does ''obslight'' store its data? ==
All data is stored in '''~/OBSLight''' and subdirectories.

== Is there a configuration file ? ==
Configuration file is '''~/OBSLight/obslightConfig'''.

== How do I run OBS light server appliance on my Desktop ? ==
While running an OBS Light appliance is simple and easy and just requires 1GB of RAM allocated to the virtual machine, running an OBS server appliance can be much more demanding but running the OBS server server appliance on your desktop or laptop (a minimum 4GB of RAM is mandatory) via a virtual machine can be very handy during evaluation tests. 
The main advantage is that you do not need a special authorisation from your IT department to start playing but you need to allocate at least 2GB to the appliance and as many CPU cores that you can spare. You need to patch on the OBS server appliance ''(need to be root)'' the file '''/etc/sysconfig/obs-worker''' to set the variable OBS_WORKER_INSTANCES to 1 (default is zero) to limit the RAM resources requires by your appliance during build process.
If you plan to build large packages such as Chromium you will need more than 2GB of RAM allocated (actually on my desktop I have 16GB). 
You can overcome that limit with the addition of an obsworker appliance on a separate server. OBS Light project provides one pre-configured to work with and OBS Light server appliance. 
If you use the Bridge mode, external OBS work appliance will be detected and used automatically (NAT more would require a complex configuration). The Worker can be running on a more powerfull unit and speed the preparation work before for example leaving the office with a complete fully built project on a laptop.
You can stop the worker on the laptop by the command '''rcobsworker stop''' ''(need to be root)''. You can check that your OBS Worker appliance can see your OBS Light Server Appliance with the command '''slptool findsrvs obs.source_server''' 
As a general rule using the bridge mode is advisable. Note ''this is '''not''' the default option of VirtualBox''.
The NAT mode is interesting to run an OBS Light server via a VPN or for unconnected demos. In that case you will need to declare NAT rules in your Vitual Machine Manager redirecting the ports 80, 81 and 82 from your local host to your OBS appliance internal NAT address ''(with VitualBox under Linux rerouting port bellow 1000 is reserved for root only)''. 
Do not forget to add a host name "obslightserver" in your workstation pointing to the OBS Light server appliance IP address or localhost in the case of a NAT configuration.

== How to show the log ? ==
* From the menu: ''Window'' -> ''Show log''
* When a long operation is running: right click on progress bar and click ''Show log''.

== Why does MeeGo's '''kernel''' package fail to build for ARM? ==
The '''kernel''' package has flags to prevent builds on ARM.
To compile an ARM kernel, you must use another package, for example the '''kernel-adaptation-n900''' package.

== How install the dependency of a package into the chroot? ==
If the project on your OBS doesn’t provide some dependencies and you must add a repository to your chroot's zypper configuration, you have two choices:
* First one, use an URL and an alias:
obslight addRepoInChRoot --projectLocalName MeeGo_1.2_oss --url http://download.meego.com/live/MeeGo:/1.2:/non-oss/MeeGo_1.2/ --alias "MeeGo_non-oss"
* Second one, add the repository of another local project:
obslight addRepoInChRoot --projectLocalName MeeGo_1.2_oss --fromProject $ProjectName

== Where to send bug reports ? ==
Bugs are centralized on [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light MeeGo's bugzilla].

= Links =
* [[OBS_Light | OBS Light main page]]
* [[ObsLightDeliverable | OBS Light deliverables]]
* [[OBS_Light_Manual | OBS Light manual]]
* [https://meego.gitorious.org/meego-developer-tools/obs-light/ OBS Light project on Gitorious]
* [https://build.pub.meego.com/project/show?project=Project%3AOBS_Light OBS Light project on MeeGo build service]

OBS Light FAQ

2012-02-17T13:13:55Z

Dominig: /* How do I run OBS light server appliance on my Desktop ? */

= Frequently Asked Questions =
== Where does ''obslight'' store its data? ==
All data is stored in '''~/OBSLight''' and subdirectories.

== Is there a configuration file ? ==
Configuration file is '''~/OBSLight/obslightConfig'''.

== How do I run OBS light server appliance on my Desktop ? ==
While running an OBS Light appliance is simple and easy and just requires 1GB of RAM allocated to the virtual machine, running an OBS server appliance can be much more demanding but running the OBS server server appliance on your desktop or laptop (a minimum 4GB of RAM is mandatory) via a virtual machine can be very handy during evaluation tests. 
The main advantage is that you do not need a special authorisation from your IT department to start playing but you need to allocate at least 2GB to the appliance and as many CPU cores that you can spare. You need to patch on the OBS server appliance ''(need to be root)'' the file '''/etc/sysconfig/obs-worker''' to set the variable OBS_WORKER_INSTANCES to 1 (default is zero) to limit the RAM resources requires by your appliance during build process.
If you plan to build large packages such as Chromium you will need more than 2GB of RAM allocated (actually on my desktop I have 16GB). 
You can overcome that limit with the addition of an obsworker appliance on a separate server. OBS Light project provides one pre-configured to work with and OBS Light server appliance. 
If you are not in NAT, external OBS work appliance will be detected and used automatically (NAT more would require a complex configuration). The Worker can be running on a more powerfull unit and speed the preparation work before for example leaving the office with a complete fully built project on a laptop.
You can stop the worker on the laptop by the command '''rcobsworker stop''' ''(need to be root)''. You can check that your OBS Worker appliance can see your OBS Light Server Appliance with the command '''slptool findsrvs obs.source_server''' 
As a general rule using the bridge mode is advisable. Note ''this is '''not''' the default option of VirtualBox''.
The NAT mode is interesting to run an OBS Light server via a VPN or for unconnected demos. In that case you will need to declare NAT rules in your Vitual Machine Manager redirecting the ports 80, 81 and 82 from your local host to your OBS appliance internal NAT address ''(with VitualBox under Linux rerouting port bellow 1000 is reserved for root only)''. 
Do not forget to add a host name "obslightserver" in your workstation pointing to the OBS Light server appliance IP address or localhost in the case of a NAT configuration.

== How to show the log ? ==
* From the menu: ''Window'' -> ''Show log''
* When a long operation is running: right click on progress bar and click ''Show log''.

== Why does MeeGo's '''kernel''' package fail to build for ARM? ==
The '''kernel''' package has flags to prevent builds on ARM.
To compile an ARM kernel, you must use another package, for example the '''kernel-adaptation-n900''' package.

== How install the dependency of a package into the chroot? ==
If the project on your OBS doesn’t provide some dependencies and you must add a repository to your chroot's zypper configuration, you have two choices:
* First one, use an URL and an alias:
obslight addRepoInChRoot --projectLocalName MeeGo_1.2_oss --url http://download.meego.com/live/MeeGo:/1.2:/non-oss/MeeGo_1.2/ --alias "MeeGo_non-oss"
* Second one, add the repository of another local project:
obslight addRepoInChRoot --projectLocalName MeeGo_1.2_oss --fromProject $ProjectName

== Where to send bug reports ? ==
Bugs are centralized on [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light MeeGo's bugzilla].

= Links =
* [[OBS_Light | OBS Light main page]]
* [[ObsLightDeliverable | OBS Light deliverables]]
* [[OBS_Light_Manual | OBS Light manual]]
* [https://meego.gitorious.org/meego-developer-tools/obs-light/ OBS Light project on Gitorious]
* [https://build.pub.meego.com/project/show?project=Project%3AOBS_Light OBS Light project on MeeGo build service]

OBS Light FAQ

2012-02-17T11:47:28Z

Dominig: /* How do I run OBS light server appliance on my Desktop ? */

= Frequently Asked Questions =
== Where does ''obslight'' store its data? ==
All data is stored in '''~/OBSLight''' and subdirectories.

== Is there a configuration file ? ==
Configuration file is '''~/OBSLight/obslightConfig'''.

== How do I run OBS light server appliance on my Desktop ? ==
While running an OBS Light appliance is simple and easy and just requires 1GB of RAM allocated to the virtual machine, running an OBS server appliance can be much more demanding but running the OBS server server appliance on your desktop or laptop (a minimum 4GB of RAM is mandatory) via a virtual machine can be very handy during evaluation tests. 
The main advantage is that you do not need a special authorisation from your IT department to start playing but you need to allocate at least 2GB to the appliance and as many CPU cores that you can spare. You need to patch on the OBS server appliance ''(need to be root)'' the file '''/etc/sysconfig/obs-worker''' to set the variable OBS_WORKER_INSTANCES to 1 (default is zero) to limit the RAM resources requires by your appliance during build process.
If you plan to build large packages such as Chromium you will need more than 2GB of RAM allocated (actually on my desktop I have 16GB). 
You can overcome that limit with the addition of an obsworker appliance on a separate server. OBS Light project provides one pre-configured to work with and OBS Light server appliance. 
If you are not in NAT, external OBS work appliance will be detected and used automatically (NAT more would require a complex configuration). The Worker can be running on a more powerfull unit and speed the preparation work before for example leaving the office with a complete fully built project on a laptop.
You can stop the worker on the laptop by the command '''rcobsworker stop''' ''(need to be root)''. You can check that your OBS Worker appliance can see your OBS Kight Server Appliance with the command '''slptool findsrvs obs.source_server''' 
As a general rule using the bridge mode is advisable. Note ''this is '''not''' the default option of VirtualBox''.
The NAT mode is interesting to run an OBS Light server via a VPN or for unconnected demos. In that case you will need to declare NAT rules in your Vitual Machine Manager redirecting the ports 80, 81 and 82 from your local host to your OBS appliance internal NAT address ''(with VitualBox under Linux rerouting port bellow 1000 is reserved for root only)''. 
Do not forget to add a host name "obslightserver" in your workstation pointing to the OBS Light server appliance IP address or localhost in the case of a NAT configuration.

== How to show the log ? ==
* From the menu: ''Window'' -> ''Show log''
* When a long operation is running: right click on progress bar and click ''Show log''.

== Why does MeeGo's '''kernel''' package fail to build for ARM? ==
The '''kernel''' package has flags to prevent builds on ARM.
To compile an ARM kernel, you must use another package, for example the '''kernel-adaptation-n900''' package.

== How install the dependency of a package into the chroot? ==
If the project on your OBS doesn’t provide some dependencies and you must add a repository to your chroot's zypper configuration, you have two choices:
* First one, use an URL and an alias:
obslight addRepoInChRoot --projectLocalName MeeGo_1.2_oss --url http://download.meego.com/live/MeeGo:/1.2:/non-oss/MeeGo_1.2/ --alias "MeeGo_non-oss"
* Second one, add the repository of another local project:
obslight addRepoInChRoot --projectLocalName MeeGo_1.2_oss --fromProject $ProjectName

== Where to send bug reports ? ==
Bugs are centralized on [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light MeeGo's bugzilla].

= Links =
* [[OBS_Light | OBS Light main page]]
* [[ObsLightDeliverable | OBS Light deliverables]]
* [[OBS_Light_Manual | OBS Light manual]]
* [https://meego.gitorious.org/meego-developer-tools/obs-light/ OBS Light project on Gitorious]
* [https://build.pub.meego.com/project/show?project=Project%3AOBS_Light OBS Light project on MeeGo build service]

OBS Light FAQ

2012-02-17T11:15:28Z

Dominig: /* How do I run OBS light server appliance on my Desktop ? */

= Frequently Asked Questions =
== Where does ''obslight'' store its data? ==
All data is stored in '''~/OBSLight''' and subdirectories.

== Is there a configuration file ? ==
Configuration file is '''~/OBSLight/obslightConfig'''.

== How do I run OBS light server appliance on my Desktop ? ==
While running an OBS Light appliance is simple and easy and just requires 1GB of RAM allocated to the virtual machine, running an OBS server appliance can be much more demanding but running the OBS server server appliance on your desktop or laptop (a minimum 4GB of RAM is mandatory) via a virtual machine can be very handy during evaluation tests. 
The main advantage is that you do not need a special authorisation from your IT department to start playing but you need to allocate at least 2GB to the appliance and as many CPU cores that you can spare. You need to patch on the OBS server appliance ''(need to be root)'' the file '''/etc/sysconfig/obs-worker''' to set the variable OBS_WORKER_INSTANCES to 1 (default is zero) to limit the RAM resources requires by your appliance during build process.
If you plan to build large packages such as Chromium you will need more than 2GB of RAM allocated (actually on my desktop I have 16GB). 
You can overcome that limit with the addition of an obsworker appliance on a separate server. OBS Light project provides one pre-configured to work with and OBS Light server appliance. 
If you are not in NAT, external OBS work appliance will be detected and used automatically (NAT more would require a complex configuration). The Worker can be running on a more powerfull unit and speed the preparation work before for example leaving the office with a complete fully built project on a laptop.
You can stop the worker on the laptop by the command '''rcobsworker stop''' ''(need to be root)'' 
As a general rule using the bridge mode is advisable. Note ''this is '''not''' the default option of VirtualBox''.
The NAT mode is interesting to run an OBS Light server via a VPN or for unconnected demos. In that case you will need to declare NAT rules in your Vitual Machine Manager redirecting the ports 80, 81 and 82 from your local host to your OBS appliance internal NAT address ''(with VitualBox under Linux rerouting port bellow 1000 is reserved for root only)''. 
Do not forget to add a host name "obslightserver" in your workstation pointing to the OBS Light server appliance IP address or localhost in the case of a NAT configuration.

== How to show the log ? ==
* From the menu: ''Window'' -> ''Show log''
* When a long operation is running: right click on progress bar and click ''Show log''.

== Why does MeeGo's '''kernel''' package fail to build for ARM? ==
The '''kernel''' package has flags to prevent builds on ARM.
To compile an ARM kernel, you must use another package, for example the '''kernel-adaptation-n900''' package.

== How install the dependency of a package into the chroot? ==
If the project on your OBS doesn’t provide some dependencies and you must add a repository to your chroot's zypper configuration, you have two choices:
* First one, use an URL and an alias:
obslight addRepoInChRoot --projectLocalName MeeGo_1.2_oss --url http://download.meego.com/live/MeeGo:/1.2:/non-oss/MeeGo_1.2/ --alias "MeeGo_non-oss"
* Second one, add the repository of another local project:
obslight addRepoInChRoot --projectLocalName MeeGo_1.2_oss --fromProject $ProjectName

== Where to send bug reports ? ==
Bugs are centralized on [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light MeeGo's bugzilla].

= Links =
* [[OBS_Light | OBS Light main page]]
* [[ObsLightDeliverable | OBS Light deliverables]]
* [[OBS_Light_Manual | OBS Light manual]]
* [https://meego.gitorious.org/meego-developer-tools/obs-light/ OBS Light project on Gitorious]
* [https://build.pub.meego.com/project/show?project=Project%3AOBS_Light OBS Light project on MeeGo build service]

OBS Light FAQ

2012-02-17T10:52:48Z

Dominig: /* How do I run OBS light server appliance on my Desktop ? */

= Frequently Asked Questions =
== Where does ''obslight'' store its data? ==
All data is stored in '''~/OBSLight''' and subdirectories.

== Is there a configuration file ? ==
Configuration file is '''~/OBSLight/obslightConfig'''.

== How do I run OBS light server appliance on my Desktop ? ==
While running an OBS Light appliance is simple and easy and just requires 1GB of RAM allocated to the virtual machine, running an OBS server appliance can be much more demanding but running the OBS server server appliance on your desktop or laptop (a minimum 4GB of RAM is mandatory) via a virtual machine can be very handy during evaluation tests. 
The main advantage is that you do not need a special authorisation from your IT department to start playing but you need to allocate at least 2GB to the appliance and as many CPU cores that you can spare. You need to patch on the OBS server appliance ''(need to be root)'' the file '''/etc/sysconfig/obs-worker''' to set the variable OBS_WORKER_INSTANCES to 1 (default is zero) to limit the RAM resources requires by your appliance during build process.
If you plan to build large packages such as Chromium you will need more than 2GB of RAM allocated (actually I succeed with 3GB but the more is the best, on my desktop I use 16GB). 
You can overcome that limit with the addition of an obsworker appliance on a separate server. OBS Light project provides one pre-configured to work with and OBS Light server appliance. 
If you are not in NAT, external OBS work appliance will be detected and used automatically (NAT more would require a complex configuration). The Worker can be running on a more powerfull unit and speed the preparation work before for example leaving the office with a complete fully built project on a laptop.
You can stop the worker on the laptop by the command '''rcobsworker stop''' ''(need to be root)'' 
As a general rule using the bridge mode is advisable. Note ''this is '''not''' the default option of VirtualBox''.
The NAT mode is interesting to run an OBS Light server via a VPN or for unconnected demos. In that case you will need to declare NAT rules in your Vitual Machine Manager redirecting the ports 80, 81 and 82 from your local host to your OBS appliance internal NAT address ''(with VitualBox under Linux rerouting port bellow 1000 is reserved for root only)''. 
Do not forget to add a host name "obslightserver" in your workstation pointing to the OBS Light server appliance IP address or localhost in the case of a NAT configuration.

== How to show the log ? ==
* From the menu: ''Window'' -> ''Show log''
* When a long operation is running: right click on progress bar and click ''Show log''.

== Why does MeeGo's '''kernel''' package fail to build for ARM? ==
The '''kernel''' package has flags to prevent builds on ARM.
To compile an ARM kernel, you must use another package, for example the '''kernel-adaptation-n900''' package.

== How install the dependency of a package into the chroot? ==
If the project on your OBS doesn’t provide some dependencies and you must add a repository to your chroot's zypper configuration, you have two choices:
* First one, use an URL and an alias:
obslight addRepoInChRoot --projectLocalName MeeGo_1.2_oss --url http://download.meego.com/live/MeeGo:/1.2:/non-oss/MeeGo_1.2/ --alias "MeeGo_non-oss"
* Second one, add the repository of another local project:
obslight addRepoInChRoot --projectLocalName MeeGo_1.2_oss --fromProject $ProjectName

== Where to send bug reports ? ==
Bugs are centralized on [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light MeeGo's bugzilla].

= Links =
* [[OBS_Light | OBS Light main page]]
* [[ObsLightDeliverable | OBS Light deliverables]]
* [[OBS_Light_Manual | OBS Light manual]]
* [https://meego.gitorious.org/meego-developer-tools/obs-light/ OBS Light project on Gitorious]
* [https://build.pub.meego.com/project/show?project=Project%3AOBS_Light OBS Light project on MeeGo build service]

OBS Light FAQ

2012-02-10T17:24:55Z

Dominig: /* How do I run OBS light server appliance on my Desktop ? */

OBS Light FAQ

2012-02-10T17:15:02Z

Dominig: /* Frequently Asked Questions */

TV Browser Transparency Management

2012-01-27T13:50:47Z

Dominig: Created page with "= Translucency Solution for Intel® CE Media Processor Based Flash Plug-in on MeeGo = This page describe how the MeeGo TV Browser accelerate video by using the G..."

= Translucency Solution for Intel® CE Media Processor Based Flash Plug-in on MeeGo =
This page describe how the [[TV Browser | MeeGo TV Browser]] accelerate video by using the GDL planes. 
'''Note:''' This implementation is specific to Intel CE4xxx HW. Other HW architecture will need modification of the code.

== 1. INTRODUCTION ==

The Intel® Atom™ processors CE4xxx have four Universal Pixel Planes (UPP) for graphics and video rendering. The hardware cursor uses the UPP_D, the X window system uses the UPP_C, and the hardware accelerated video is rendered on UPP_B or UPP_A in a typical environment.

For hardware accelerated video playback, specific plug-ins such as the Adobe Flash® Player plug-in (hereafter referred to as “Flash plug-in”) or a commercial Blue-ray stack need to render the graphics overlay on the X window system and render the videos on the underlying planes. This requires that the alpha values of the graphics overlay be applied to the plane level to see through the X window system and display the videos.

'''Note :''' The Flash plug-in is not available as open source and requires specific license from Adobe®.

== 2. BROWSER REQUIREMENT ==

In MeeGo TV, mutter is the compositing window manager and provides the capability to manage the plane level alpha values. X client applications may send commands to mutter through window manager hints to make a window translucent or transparent. The commands will need to provide the XID of the window and specify a rectangle that needs to be translucent or transparent. Since all sub-windows share the same off-screen pixel buffer with the top level window, mutter only handles the XIDs that belong to a top level window.

The first thing browser needs to do is setting mutter hints to the top level window of the browser (the first level window) and apply mutter hints to it. The hint string is “meego-tv-cutout-x=0:meego-tv-cutout-y=0:meego-tv-cutout-width=0:meego-tv-cutout-height=0:meego-tv-half-trans=1:meego-tv-full-window=1”, which means the whole browser window can be translucent and the opacity is defined by alpha values (areas outside the Flash plug-in has alpha value 255, so won’t be seen through).

According to the Flash plug-in usage scenario, the Flash plug-in will use a 32 bpp surface and the pixel values including the alpha channel need to be applied to the top level window. In this way, mutter will be able to apply the 32 bpp window‘s alpha values to the hardware plane.

In windowed mode, the Flash plug-in owns its own sub-window. To apply alpha values to the top level window’s pixel buffer, all its ancestor windows need to be 32 bpp. In the Chromium browser, the window chain includes 5 layers. And in the Flash plug-in there can be several levels according to the Flash plug-in implementation.

A list of the window hierarchy in the chromium browser is shown in the following table.

{|
|'''Level'''|| '''Window'''|| '''Function'''|| '''Creation'''||
|+
|1|| Browser Window|| This is the top most window|| chrome/browser/ui/gtk/browser_window_gtk.cc||
|+
|2|| Tab Window|| Each tab will create a tab window|| chrome/browser/renderer_host/render_widget_host_view_gtk.cc||
|+
|3|| Plugin Container|| Created for container manager use.|| webkit/plugins/npapi/gtk_plugin_container_manager.cc||
|+
|4|| !GtkPlug|| The top level window of plugin process and the !GtkPlug mechanism for embedding into other process ||webkit/plugins/npapi/webplugin_delegate_impl_gtk.cc||
|+
|5|| !GtkSocket|| The !GtkSocket ID will be passed to plugin process|| webkit/plugins/npapi/webplugin_delegate_impl_gtk.cc||
|}
The key modification is to change the window that is 24 bpp to 32 bpp. This can be done by getting the rgba colormap from the screen and setting the colormap to the corresponding GtkWidget.
If a customer wants to apply this change to the WebKit browser, similar changes need to be made in WebKit and the WebView container.

In windowless mode, the browser provides a pixmap to the flash plugin as a canvas to draw on. If the “wmode” property is set to “opaque”, the pixmap is filled with an opaque color “0xFF000000”. If the “wmode” property is set to “transparent”, the pixmap is filled with the background image which is composed of HTML elements in the underlying layers. To enable multi-plane transparency, the browser should meet three preconditions.

# Provide a 32 bpp pixmap to the flash plugin. It is created at webkit/plugins/npapi/webplugin_delegate_impl_gtk.cc. The information of visual and depth should be told to the flash plugin.

# Fill the pixmap appropriately before sending to the flash plugin. In “transparent” mode, the pixmap created by browser should be filled with the backgournd image whose alpha values are 0xFF. In “opaque” mode, the pixmap should be filled with color “0xFF000000”. The fill operation should be a Source Blit operation.

# Keep the alpha channel in the pixmap returned by the flash plugin and render it to top level window. The pixmap should be source blitted to share memory in chromium browser. And when the data in share memory is rendered to backing store and X window, the visual format should always have the depth of 32 and class of TrueColor.

== 3. PLUGIN REQUIREMENT ==

The plug-in need to differentiate whether the usage scenario is hardware accelerated video. If not, everything should be rendered to the plugin window with alpha values 255 (Fully opaque). Otherwise, it needs to apply mutter translucency to render translucent graphics overlay on X window system.

A list of window hierarchy in plugin.
{|
|Level|| Window|| Function|| Creation||
|+
|6|| !GtkPlug|| The fifth layer !GtkSocket is the window ID plugin will get. Plugin will first create a !GtkPlug widget as child of !GtkSocket and as the container for other widgets ||Plugin SetWindow Function||
|+
|7|| Canvas Widget|| Plugin draw everything in this widget|| In the Plugin||
|}
To apply the alpha channel of the 32bpp pixbuf to UPP_C, you have to draw the 32bpp pixel buffer to the 7th level window. This could be done by cairo graphics engine. We tried to use the gtk functions gdk_pixbuf_render_to_drawable, but the alpha channel does not apply to the 7th window level, but to the background of the widget, so do not use it.

For windowless mode, the plugin needs to draw the 32 bpp pixel buffer to the pixmap provided by a browser. And the draw operation should be a source blit instead of blending.

Please notice that any top level window created by the flash plugin does not have the mutter hints set already, and the flash plugin is responsible to set hints by itself if this window needs to apply multi-plane transparency. A good example of this scenario is the full screen playback.

== 4. BUILD INSTRUCTION ==
1. Browser:
# mic-chroot to meego image file system:
# Install tool chain: such as make, gcc, libtool, rpm-build, etc.
# zypper si chromium # This will install build dependencies and source code at ~/rpmbuild
# cp the patch to ~/rpmbuild/SOURCE
# cd ~/rpmbuild/SPEC, edit the spec file to add the patch into build
# rpmbuild -ba chromium.spec
# find the rpm at ~/rpmbuild/RPMS

2. DiamondX Sample Plugin
* ./configure
* make
* make install-plugin

3. Test:
* play a video at UPP_B using gst-launch or cl_app
* chromium-browser play an HD H.264 video from any flash based web site such as YouTube.

== 5. KNOWN ISSUES ==
Setting the browser sub-window chain to 32 bpp will cause the software version of the Flash plug-in from Adobe’s official website to fail. A simple solution is to use an environment variable to indicate to the browser which version of the Flash plug-in it’s using and have the browser base its behavior on that information.

TV Browser Video HW acceleration

2012-01-27T13:33:41Z

Dominig: /* HTML5 Video Hardware Acceleration */

= HTML5 Video Hardware Acceleration =

This page describe how the [[TV Browser | MeeGo TV Browser]] accelerate video by using UMMS to replace FFMPEG. 
'''Note:''' This implementation is specific to Intel CE4xxx HW. Other HW architecture will need modification of the code.

This concept was presented during the [http://sf2011.meego.com/program/sessions/hardware-accelerated-html5-video-solution-meego-browser MeeGo conference in San Francisco].
== MeeGo TV Hardware Capability ==

* Video Display Controller Architecture
[[File:MeeGoTV-vdc.png]]

* 4-5 Universal Pixel Plane for graphics and video rendering
* Hardware blender supports IAP and ARGB pixel format UPP
* Two hardware decoders - H.264, VC1, MPEG2. support 2-way 1080p video decoding
* Hardware Scaler
* PVR SGX Graphics Core

== Multi-plane Solution ==
[[File:MeeGoTV-mp-solution.png]]

* Render Process:
** Replace the FFMPEG based !WebMediaPlayer with UMMS based !UmmsWebMediaPlayer
** Webkit calculates video destination area and transparent area.
* Browser Process:
** DBus bridge in browser to adapt security sandbox
** Issue plane level transparency commands
* Unified Multimedia Service
** The actual playback engine
** Playback and media control
** DBus interface
** Multi-session support
** Multi media engines(Gstreamer, !OpenMax…)
* mutter-meego-tv: Handle hints for transparency
** Facts:
*** Browser rendered on X window
*** X rendered on above plane,
*** Hardware accelerated video is rendered on underneath plane.
*** X server does not handle alpha channel by default
*** Alpha channel is used in plane level with Pixel format ARGB
** Solution: Windows manager handles the alpha channel when compositing
** Result: See through the right area of X to show video

== Video As Texture ==
[[File:MeeGoTV-vat-solution.png]]
* Render & Browser processes co work to redirect playback commands to UMMS
* UMMS is responsible for hardware accelerated video decoding and color conversion.
* RGBA data is shared between UMMS and render process
* Render process renders the texture to the video area.

== Tradeoff ==
* Multi-plane
** Pursues maximized performance
** Depend on wm, currently only mutter is enhanced.
** Video/browser display memory separated, advanced feature not available
* Video as Texture
** Keep the integrity of the browser window’s display memory, which enables a lot of advanced HTML5 features.
** Involve color conversion and memory copy that can be expensive for HD videos

TV Browser Video HW acceleration

2012-01-27T11:25:12Z

Dominig: /* HTML5 Video Hardware Acceleration */

= HTML5 Video Hardware Acceleration =

'''Note:''' This implementation is specific to Intel CE4xxx HW. Other HW architecture will need modification of the code.

This concept was presented during the [http://sf2011.meego.com/program/sessions/hardware-accelerated-html5-video-solution-meego-browser MeeGo conference in San Francisco].
== MeeGo TV Hardware Capability ==

* Video Display Controller Architecture
[[File:MeeGoTV-vdc.png]]

* 4-5 Universal Pixel Plane for graphics and video rendering
* Hardware blender supports IAP and ARGB pixel format UPP
* Two hardware decoders - H.264, VC1, MPEG2. support 2-way 1080p video decoding
* Hardware Scaler
* PVR SGX Graphics Core

== Multi-plane Solution ==
[[File:MeeGoTV-mp-solution.png]]

* Render Process:
** Replace the FFMPEG based !WebMediaPlayer with UMMS based !UmmsWebMediaPlayer
** Webkit calculates video destination area and transparent area.
* Browser Process:
** DBus bridge in browser to adapt security sandbox
** Issue plane level transparency commands
* Unified Multimedia Service
** The actual playback engine
** Playback and media control
** DBus interface
** Multi-session support
** Multi media engines(Gstreamer, !OpenMax…)
* mutter-meego-tv: Handle hints for transparency
** Facts:
*** Browser rendered on X window
*** X rendered on above plane,
*** Hardware accelerated video is rendered on underneath plane.
*** X server does not handle alpha channel by default
*** Alpha channel is used in plane level with Pixel format ARGB
** Solution: Windows manager handles the alpha channel when compositing
** Result: See through the right area of X to show video

== Video As Texture ==
[[File:MeeGoTV-vat-solution.png]]
* Render & Browser processes co work to redirect playback commands to UMMS
* UMMS is responsible for hardware accelerated video decoding and color conversion.
* RGBA data is shared between UMMS and render process
* Render process renders the texture to the video area.

== Tradeoff ==
* Multi-plane
** Pursues maximized performance
** Depend on wm, currently only mutter is enhanced.
** Video/browser display memory separated, advanced feature not available
* Video as Texture
** Keep the integrity of the browser window’s display memory, which enables a lot of advanced HTML5 features.
** Involve color conversion and memory copy that can be expensive for HD videos

TV Browser

2012-01-27T11:22:46Z

Dominig: /* MeeGo TV Browser */

= MeeGo TV Browser =

1 Short expression of the need
--------------------------------
TV industry and in particular IPTV has used browsers for years to create TV portals. In IPTV specialised companies such as ANT (Cambridge, UK), Opera (Oslo, Norway) or Access (Tokyo, Japan) have created specialised browser for these use cases.
These specialised browsers were optimized for TV at the detriment of their possibility to surf the open internet.
As today the requirement to browse the open internet is imposed on TV, there is a need to provide an “open internet” capable browser which can be integrated in a TV and can be used to create TV portals.
These portals are commonly used to provide the business logic which run locally on the device an is written in AJAX. To enable the control of the TV and Media Centre an API accessible from JavaScript must be added to the Browser.

2 Purpose/audience
--------------------
The purpose of this document is to provide an understanding of the solution which has been developed by the MeeGo TV project. It addresses the developers who will have to deliver a working implementation.

3 Overview
-------------
The internet world has created browser for PC. Assuming not only a mouse and a keyboard, but also a 50 cm viewing with a multi windows presentation layer and a skilled human who drive the beast.
Unfortunately, a TV has neither a keyboard or a mouse, the vision is done from 3m, there is no windowing concept and the Live TV presentation remains in control of the UI all the time. TV needs is a browser which address some critical issues.
Controllable by an external application.
* Instant start
* Accept alternative input method
* Support HW accelerated Video
* Give access to all the TV features from Javascript
** System configuration
** Asset browsing
** Video and Audio
** PVR and Pause live TV.
** Video and Audio output
** Input devices

4 Documentation
----------------------------

Requirements
* [[File:Meego TV JavaScriptAPI requirement.pdf | Requirement for a TV Javascript API]] 
* [[File:Meego TV Browser V0.2.odt | Requirement for TV Browser]] 

User Manual
* [[TV Browser Javascript D-Bus API design]]
* [[TV Browser Control API]]
* [[TV Browser Javascript API]]
* [[TV Browser Video HW acceleration]]
* [[TV Browser Transparency Management]]

Related Topics
* Universal Multi Media Service [[umms | UMMS]]

5 Where is the code
-----------------
Visit MeeGo OBS and search for meego-tv-browser
https://build.meego.com

or directly in the GIT repo 
http://meego.gitorious.org/meego-middleware/meego-tv-browser 
http://meego.gitorious.org/meego-middleware/mutter-meego-tv

TV Browser Video HW accelleration

2012-01-27T11:22:22Z

Dominig: moved TV Browser Video HW accelleration to TV Browser Video HW acceleration: Spelling error correction

#REDIRECT [[TV Browser Video HW acceleration]]

TV Browser Video HW acceleration

2012-01-27T11:22:22Z

Dominig: moved TV Browser Video HW accelleration to TV Browser Video HW acceleration: Spelling error correction

= HTML5 Video Hardware Acceleration =

== MeeGo TV Hardware Capability ==

* Video Display Controller Architecture
[[Image(vdc.PNG)]]

* 4-5 Universal Pixel Plane for graphics and video rendering
* Hardware blender supports IAP and ARGB pixel format UPP
* Two hardware decoders - H.264, VC1, MPEG2. support 2-way 1080p video decoding
* Hardware Scaler
* PVR SGX Graphics Core

== Multi-plane Solution ==
[[Image(mp-solution.PNG)]]

* Render Process:
** Replace the FFMPEG based !WebMediaPlayer with UMMS based !UmmsWebMediaPlayer
** Webkit calculates video destination area and transparent area.
* Browser Process:
** DBus bridge in browser to adapt security sandbox
** Issue plane level transparency commands
* Unified Multimedia Service
** The actual playback engine
** Playback and media control
** DBus interface
** Multi-session support
** Multi media engines(Gstreamer, !OpenMax…)
* mutter-meego-tv: Handle hints for transparency
** Facts:
*** Browser rendered on X window
*** X rendered on above plane,
*** Hardware accelerated video is rendered on underneath plane.
*** X server does not handle alpha channel by default
*** Alpha channel is used in plane level with Pixel format ARGB
** Solution: Windows manager handles the alpha channel when compositing
** Result: See through the right area of X to show video

== Video As Texture ==
[[Image(vat-solution.PNG)]]
* Render & Browser processes co work to redirect playback commands to UMMS
* UMMS is responsible for hardware accelerated video decoding and color conversion.
* RGBA data is shared between UMMS and render process
* Render process renders the texture to the video area.

== Tradeoff ==
* Multi-plane
** Pursues maximized performance
** Depend on wm, currently only mutter is enhanced.
** Video/browser display memory separated, advanced feature not available
* Video as Texture
** Keep the integrity of the browser window’s display memory, which enables a lot of advanced HTML5 features.
** Involve color conversion and memory copy that can be expensive for HD videos

File:MeeGoTV-vdc.png

2012-01-27T11:09:41Z

Dominig:

File:MeeGoTV-vat-solution.png

2012-01-27T11:09:12Z

Dominig:

File:MeeGoTV-mp-solution.png

2012-01-27T11:08:47Z

Dominig:

TV Browser Video HW acceleration

2012-01-27T11:07:03Z

Dominig: Created page with "= HTML5 Video Hardware Acceleration = == MeeGo TV Hardware Capability == * Video Display Controller Architecture Image(vdc.PNG) * 4-5 Universal Pixel Plane for graphics an..."

TV Browser Javascript D-Bus API design

2012-01-27T11:00:27Z

Dominig: Created page with "== Javascript D-Bus API Overview == This document is a design of JavaScript D-Bus API for MeeGo TV browser === What does D-Bus API provide? === The D-Bus API ..."

== Javascript D-Bus API Overview ==
This document is a design of JavaScript D-Bus API for [[ TV Browser | MeeGo TV browser]]

=== What does D-Bus API provide? ===
The D-Bus API provides interface to acces D-Bus service with Javascript language bindings.
There are actually multiple D-Bus message buses running on MeeGo (and on your average Linux system) at any one time, of two types:
* The system bus is a machine-global, single instance of the daemon with security restrictions on what messages it will accept. It's used for system-wide communication and communication between the user desktop and the operating system.
* A session bus is created for each user session. It allows applications within that user session to communicate. Most MeeGo D-Bus services (connman etc.) communicate via the session bus.

To get system bus, use the following code snippet:

var system = dbuslib.system_bus();

To get session bus,

var session = dbuslib.session_bus();

=== The services, interfaces and objects ===
Interfaces are the contract between an object and its callers, much like interfaces in Java, GObject etc.. An interface, as in most object-oriented programming environments, defines the methods and properties an object exposes. In addition, D-Bus interfaces can also contain signals. Signals provide a way for objects to notify other objects about events which happen to them: for example, a Door interface might provide a signal to other objects when it is opened, perhaps called door-opened. (A nearby Doorman object might listen out for door-opened signals, so it knows when people come into the building.)

Each D-Bus object implements one or more interfaces. Most implement two standard interfaces as a minimum, org.freedesktop.DBus.Introspectable and org.freedesktop.DBus.Properties.

The following code gives an example of get interface object with given arguments
<code>
var iface = dbuslib.get_interface(session, //the bus
"org.freedesktop.compiz", //the service name
"/org/freedesktop/compiz", //the object path
"org.freedesktop.compiz"); //the interface
</code>

The returned interface also retrieves the method and signal interfaces
{|
| '''Type''' || '''Prototype''' || '''ProtoType In js''' ||
|
+
| Method || getPlugins() || iface.getPlugins() ||
|+
| Method || getPluginMetaData(String) || iface.getPluginMetaData(String) ||
|+
| Signal || pluginChanged() || iface.pluginChanged() ||
|}
=== The method call ===
The call message will contain any arguments to the method. The reply message may indicate an error, or may contain data returned by the method.

var return_value = iface.GetPlugins();
console.log(return_value);

=== The signal emitting ===
A signal in DBus consists of a single message, sent by one process to any number of other processes.

iface.pluginChanged.onemit = funcion() {
console.log("plugin changed callback");
}

=== The sample code ===
The following is the full sample code

var session = dbuslib.session_bus();
var iface = dbuslib.get_interface(session, //the bus
"org.freedesktop.compiz", //the service name
"/org/freedesktop/compiz", //the object path
"org.freedesktop.compiz"); //the interface

var return_value = iface.GetPlugins();
console.log(return_value);

iface.pluginChanged.onemit = funcion() {
console.log("plugin changed callback");
}

TV Browser

2012-01-27T10:53:16Z

Dominig: /* MeeGo TV Browser */

= MeeGo TV Browser =

1 Short expression of the need
--------------------------------
TV industry and in particular IPTV has used browsers for years to create TV portals. In IPTV specialised companies such as ANT (Cambridge, UK), Opera (Oslo, Norway) or Access (Tokyo, Japan) have created specialised browser for these use cases.
These specialised browsers were optimized for TV at the detriment of their possibility to surf the open internet.
As today the requirement to browse the open internet is imposed on TV, there is a need to provide an “open internet” capable browser which can be integrated in a TV and can be used to create TV portals.
These portals are commonly used to provide the business logic which run locally on the device an is written in AJAX. To enable the control of the TV and Media Centre an API accessible from JavaScript must be added to the Browser.

2 Purpose/audience
--------------------
The purpose of this document is to provide an understanding of the solution which has been developed by the MeeGo TV project. It addresses the developers who will have to deliver a working implementation.

3 Overview
-------------
The internet world has created browser for PC. Assuming not only a mouse and a keyboard, but also a 50 cm viewing with a multi windows presentation layer and a skilled human who drive the beast.
Unfortunately, a TV has neither a keyboard or a mouse, the vision is done from 3m, there is no windowing concept and the Live TV presentation remains in control of the UI all the time. TV needs is a browser which address some critical issues.
Controllable by an external application.
* Instant start
* Accept alternative input method
* Support HW accelerated Video
* Give access to all the TV features from Javascript
** System configuration
** Asset browsing
** Video and Audio
** PVR and Pause live TV.
** Video and Audio output
** Input devices

4 Documentation
----------------------------

Requirements
* [[File:Meego TV JavaScriptAPI requirement.pdf | Requirement for a TV Javascript API]] 
* [[File:Meego TV Browser V0.2.odt | Requirement for TV Browser]] 

User Manual
* [[TV Browser Javascript D-Bus API design]]
* [[TV Browser Control API]]
* [[TV Browser Javascript API]]
* [[TV Browser Video HW accelleration]]
* [[TV Browser Transparency Management]]

Related Topics
* Universal Multi Media Service [[umms | UMMS]]

5 Where is the code
-----------------
Visit MeeGo OBS and search for meego-tv-browser
https://build.meego.com

or directly in the GIT repo 
http://meego.gitorious.org/meego-middleware/meego-tv-browser 
http://meego.gitorious.org/meego-middleware/mutter-meego-tv

TV Browser

2012-01-26T19:02:45Z

Dominig: /* MeeGo TV Browser */

= MeeGo TV Browser =

1 Short expression of the need
--------------------------------
TV industry and in particular IPTV has used browsers for years to create TV portals. In IPTV specialised companies such as ANT (Cambridge, UK), Opera (Oslo, Norway) or Access (Tokyo, Japan) have created specialised browser for these use cases.
These specialised browsers were optimized for TV at the detriment of their possibility to surf the open internet.
As today the requirement to browse the open internet is imposed on TV, there is a need to provide an “open internet” capable browser which can be integrated in a TV and can be used to create TV portals.
These portals are commonly used to provide the business logic which run locally on the device an is written in AJAX. To enable the control of the TV and Media Centre an API accessible from JavaScript must be added to the Browser.

2 Purpose/audience
--------------------
The purpose of this document is to provide an understanding of the solution which has been developed by the MeeGo TV project. It addresses the developers who will have to deliver a working implementation.

3 Overview
-------------
The internet world has created browser for PC. Assuming not only a mouse and a keyboard, but also a 50 cm viewing with a multi windows presentation layer and a skilled human who drive the beast.
Unfortunately, a TV has neither a keyboard or a mouse, the vision is done from 3m, there is no windowing concept and the Live TV presentation remains in control of the UI all the time. TV needs is a browser which address some critical issues.
Controllable by an external application.
* Instant start
* Accept alternative input method
* Support HW accelerated Video
* Give access to all the TV features from Javascript
** System configuration
** Asset browsing
** Video and Audio
** PVR and Pause live TV.
** Video and Audio output
** Input devices

4 Documentation
----------------------------

Requirements
* [[File:Meego TV JavaScriptAPI requirement.pdf | Requirement for a TV Javascript API]] 
* [[File:Meego TV Browser V0.2.odt | Requirement for TV Browser]] 

User Manual
* [[TV Browser Control API]]
* [[TV Browser Javascript API]]
* [[TV Browser Transparency Management]]

Related Topics
* Universal Multi Media Service [[umms | UMMS]]

5 Where is the code
-----------------
Visit MeeGo OBS and search for meego-tv-browser
https://build.meego.com

or directly in the GIT repo 
http://meego.gitorious.org/meego-middleware/meego-tv-browser 
http://meego.gitorious.org/meego-middleware/mutter-meego-tv

TV Browser

2012-01-26T19:02:20Z

Dominig: /* MeeGo TV Browser */

= MeeGo TV Browser =

1 Short expression of the need
--------------------------------
TV industry and in particular IPTV has used browsers for years to create TV portals. In IPTV specialised companies such as ANT (Cambridge, UK), Opera (Oslo, Norway) or Access (Tokyo, Japan) have created specialised browser for these use cases.
These specialised browsers were optimized for TV at the detriment of their possibility to surf the open internet.
As today the requirement to browse the open internet is imposed on TV, there is a need to provide an “open internet” capable browser which can be integrated in a TV and can be used to create TV portals.
These portals are commonly used to provide the business logic which run locally on the device an is written in AJAX. To enable the control of the TV and Media Centre an API accessible from JavaScript must be added to the Browser.

2 Purpose/audience
--------------------
The purpose of this document is to provide an understanding of the solution which has been developed by the MeeGo TV project. It addresses the developers who will have to deliver a working implementation.

3 Overview
-------------
The internet world has created browser for PC. Assuming not only a mouse and a keyboard, but also a 50 cm viewing with a multi windows presentation layer and a skilled human who drive the beast.
Unfortunately, a TV has neither a keyboard or a mouse, the vision is done from 3m, there is no windowing concept and the Live TV presentation remains in control of the UI all the time. TV needs is a browser which address some critical issues.
Controllable by an external application.
* Instant start
* Accept alternative input method
* Support HW accelerated Video
* Give access to all the TV features from Javascript
** System configuration
** Asset browsing
** Video and Audio
** PVR and Pause live TV.
** Video and Audio output
** Input devices

4 Documentation
----------------------------

Requirements
* [[File:Meego TV JavaScriptAPI requirement.pdf | Requirement for a TV Javascript API]] 
* [[File:Meego TV Browser V0.2.odt | Requirement for TV Browser]] 

User Manual
* [[TV Browser Control API]]
* [[TV Browser Javascript API]]
* [[TV Browser Transparency Management]]

Related Topics
* Universal Multi Media Service [[umms]]

5 Where is the code
-----------------
Visit MeeGo OBS and search for meego-tv-browser
https://build.meego.com

or directly in the GIT repo 
http://meego.gitorious.org/meego-middleware/meego-tv-browser 
http://meego.gitorious.org/meego-middleware/mutter-meego-tv