1.3.0 Release Candidate Process

{pop-away:metadata | comments | children | labels}

{anchor:tags}

In this page you can find the following items:

{toc:style=circle|maxLevel=4|printable=true}

h3. Release Candidate Source Code
----
The following list includes all the release candidates published so far for the 1.3.0 version:

h3. New features and improvements
----
The following list includes the most important improvements on this new release. During the release candidate testing process we will be updating the documentation, both in the code (at {{docs/}}) and in this wiki regarding these changes. Anyway, you can use the usual channels for any questions or suggestions - email, github or the community list.


*New Features:*

* New [RTP device module|#rtp] \- to support RTP network devices such as Axis cameras. (mpeg4 and h264)
* New [Custom device module|#custom] \- to test new sources within Galicaster using GStreamer syntax. (advanced users)
* [External scripts in profiles|#scripts] for device configuration.
* [Configurable encoder and muxer|#encoder].
* Close session and shutdown option on the UI.
* Save crashed recordings on restart.

*Improvements:*

* Ruled VU meter.
* Configurable side-by-side layout.
* New pop-up decoration.
* Configurable UI resolution.
* [Configurable logger|#logger]. (location, syslog, rotation...)
* [Improved metadata treatment|#metadata].
* [Updated REST endpoint|#rest].

*New or improved Plugins*

* New Check_Repository_plugin: To start missed scheduled recordings on startup.
* Screen_Saver_Plugin: improved screensaver control for Ubuntu 12.04.
* No_audio_dialog_plugin: general improvement, more configurable.

h3. New documentation -- under construction {anchor:docs}
----
New documentation has been included in the code ({{docs}} folder) as well as in this wiki. This documentation is both partial and provisional but is already useful. Following the release process we will be updating it.

** [Galicaster:Epiphan framegrabbers]

** [Galicaster:Pulse device module]
** [Galicaster:Epiphan device module]
** [Galicaster:Datapath device module]
** [Galicaster:Hauppauge device module]
** [Galicaster:Blackmagic device module]
** [Galicaster:Firewire device module]
** [Galicaster:RTP device module]

h3. Acknowledgments

We will like to thank those whose contribution to this 1.3.0 release has been outstanding:

Karen Dole, Harvard University (USA)
Jussi Talaskivi,University of Juväskilä (Finland)
Olav Bringedal, University of Bergen ( Norway)
Guillem Rivas & Miguel Escrivá, University Politechnic of Valencia (Spain)

We also want to extend our gratitude to all the people that have tested Galicaster, contributed reporting bugs, proposed issues and given suggestions through the different communication channels.


h3. New Features description
----
{anchor:scripts}

h4. External scripts in profiles

From 1.3 every profile can set up a configuration script. The script will be executed before the profile is loaded.
Usually a script will configure a certain device but it could include any other task.

To specify the script to be executed, include its full path in the profile data section:
{code:none}
[data]
name = profile
execute = /home/user/scripts/script1.sh
{code}

*Example:*
Configure a Logitech c920 to a power line frequency of 50Hz
{code:none}
# file: /home/user/scripts/script1.sh
v4l2-ctl -d /dev/webcam -c power_line_frequency=1
{code}

{anchor:encoder}

* RTP only allows to define the muxer

*Parameters and examples:*
* videoencoder
** x264enc quantizer=22 speed-preset=2 profile=1
** xvidenc bitrate=50000000
** ffenc_mpeg2video quantizer=4 gop-size=1 bitrate=10000000
* audioencoder
** lamemp3enc target=1 bitrate=192 cbr=true
* muxer
** flvmux
** avimux
** mpegtsmux

{section}
{column:width=60%}
{note}In RC1 the Pulse parameter is {{{_}encoder{_}}}, not {{{_}audioencoder{_}}}. This denomination was corrected in RC2.{note}
{column}
{column}{column}
{section}
To know more of the parameters of each muxer and encoder consult the Gstreamer documentation.
{code:none}gst-inspect flvmux{code}

Consult us for instructions to configure your custom encoder and muxer.

*Example:*
Configure a Logitech c920 to encode a 720p, H264+MP4 video:
{code:none}
[track1]
name = Webcam
videoencoder = x264enc bitrate=1000 pass=5 quantizer=23
location = /dev/video0
file = CAMERA.mp4
device = v4l2
muxer = mp4mux faststart=true
caps = image/jpeg, framerate = 24/1, width=1280, height=720
flavor = presenter
{code}


{anchor:rtp}

{anchor:custom}

h4. Custom device module

This feature is meant for advanced users. You can define a custom bin to test new sources within Galicaster.

{code:none}
[track1]
name = custom
location = default
file = CAMERA.avi
device = custom
flavor = presenter
active = True
pipestr = videotestsrc name=gc-custom-src is-live=true ! video/x-raw-yuv,framerate=10/1,width=640,height=480 ! tee name=tee-vt ! queue ! ffmpegcolorspace ! xvimagesink sync=false async=false qos=false name=gc-custom-preview tee-\
vt. ! queue ! valve drop=false name=gc-custom-valve ! queue ! ffmpegcolorspace ! queue ! filesink name=gc-custom-sink async=false
{code}

{section}
{column:width=60%}
{note:title=Element naming}
The elements source (src), valve and sink must be named as those in the example, so that the program can identify them.
{note}
{column}
{column:width=40%}
{column}
{section}

{anchor:logger}

h4. Configurable logger

The log files location, the minimum log level shown and whether the logs rotate or not can be easily set up in this version:

{code:none}
[logger]
path = /var/log/galicaster/galicaster.log
level = DEBUG
rotate = True
{code}

{section}
{column:width=60%}
{note:title=Directory IO permissions}
Make sure Galicaster has write permissions in the directory where the logs are to be stored.
{note}
{column}
{column:width=40%}
{column}
{section}

Galicaster can also use the system log (syslog) instead:

{code:none}
[logger]
use_syslog = True
{code}


{anchor:rest}

h4. REST Plugin

The REST endpoint plugin for Galicaster is a module to provide an experimental REST interface to access some parameters and features of Galicaster.

If activated, the REST plugin will response at the localhost address through the 8080 port.

Current endpoints include:
|| URL || Description ||
| {{*/state{*}}} | Show some state values |
| {{*/repository{*}}} | List MP keys |
| {{*/repository/<id>*}} | Get MP manifest (XML) |
| {{*/metadata/<id>*}} | Get MP metadata (JSON) |
| {{*/start{*}}} | Start a manual recording |
| {{*/stop{*}}} | Stop current recording |
| {{*/operation/ingest/<id>*}} | Ingest MP |
| {{*/operation/sidebyside/>id>*}} | Export MP to side-by-side |
| {{*/operation/exporttozip/<id>*}} | Export MP to zip |
| {{*/screen{*}}} | Get a screnshot of the current desktop |

Activating this plugin is as simple as:
{code:none}
[plugins]
rest = True
{code}

{section}
{column:width=60%}
{note:title=Visualizing JSON}To test this plugin, we recommend using add-ons on your browser to visualize JSON data.{note}
{column}
{column}{column}
{section}

{anchor:metadata}

h4. Galicaster 1.3 Metadata Treatment

Before Galicaster 1.3, only some metadata was collected, specially with Series metadata, where only _name_ and _identifier_ were preserved.

After studying and discussing the current situation with metadata regarding Matterhorn and Galicaster, we have made the following modifications in the behaviour on Galicaster's side:

* All metadata is captured, both in episode and series.
* If custom parameters are included in the Matterhorn schedule they are preserved through Galicaster.
* The only parameters that can be modified are: title, presenter, language, description and series.
** A change in series makes all series parameters change at once.
* Empty parameters are not included in the files.

Unfortunately Matterhorn overwrites the metadata of a returning mediapackage, so modifications have to be made in order to preserve any changes made on the capturer. However, if a mediapackage is ingested a second time, all the metadata - but the identifier - will be preserved.

h3. Regarding device behaviour on missing signal and resolution change.

We've compiled a list of the behaviour of the video devices when the signal is missing - unplugged or camera off - or the resolution changes - for VGA capturing devices.

This list was checked over Ubuntu 12.04 with newest drivers and Galicaster 1.3.0rc1

* Datapath:
** Provides configurable No signal black screen, with time counter.
** Scale to designated resolution.
** We recommend using the newer possible driver.
* NCast:
** Provides mock signal.
** Scales input.
* Epiphan:
** Newest drivers provides green screen on failure and scales on resolution change.
** V4L2 device module can be used instead of Epiphan's, specifying caps
* Osprey:
** provides a blue screen
* Bluecherry PV:
** provides a blue screen with caps well configured, otherwise it may fail
* Hauppauge:
** Provides black. If configured on Tuner it provides noise.
** Unfortunately, switch to a good input and standard requires to stop the preview. Other sources can switch on runtime (Osprey f.i.).
* *RTP: Fails*
* *Blackmagic: Fails "silently".*
** It may be a GStreamer issue since the driver works with the vendor SW.
** External HW can prevent failures.
** Doesn't allow resolution change.
* *Firewire: Fails*
* *Webcams: Fails and Galicaster crashes.*

Silently means that it won't report an error on Galicaster but the resulting MP will be erronous.

Summing up; Firewire, RTP, webcams and Blackmagic sources need continuous signal.
If signal recovers, user can reload the profile except for webcams, where Galicaster needs to be restarted manually.