Galicaster Configuration

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

{section}
{column:width=69%}
There are two types of configuration files: general configuration files and input configuration files:

There are two *general configuration* files: *conf-dist.ini* and *conf.ini*. The idea is to set default values on the first one and use the second to set the current configuration. _If any duplicated value between the two files, conf.ini values will prevail._ Each general configuration file is divided in sections, each one explained below, on this very same page.

In addition Galicaster 1.2 supports a *input profile* logic. Profiles are sets of configuration for devices - tracks - that can be loaded to run together. Profiles are listed on a menu on the welcome page, thus being available only for admin users. To know more about input profile please visit [this page|Galicaster:Input Profiles].

* Sections
** [Basic|#config_basic]
** [Screen|#config_screen]
** [Ingest|#config_ingest] (Updated)
** [Allows|#config_allows]
** [Tracks|#config_track]
*** [Generic V4L2|#v4l]
*** [Epiphan|#vga2usb]
*** [Pulse Audio|#pulse]
*** [Blackmagic|#blackmagic] (Updated)
*** [Hauppauge|#hauppauge]
*** [Firewire|#firewire] (New)

{bgcolor:yellow}
{table:align=center}
{td}
{center}
h5. Documentation
{center}

# [Hardware recommendations|Hardware recommendations]
#* [Cookbook|Cookbook]
# [Software installation|Software installation]
#* [Upgrading from older versions]
# [Configuration manual|Galicaster Configuration].
# [User's Guide|User Guide]
#* [FAQ|FAQ]
* [Quick installation guide|Quick installation guide]
\\ \\
{td}
{table}
{bgcolor}
{column}
{section}

h5. Sections
The files are divided in sections. The beginning of a section is marked by a keyword indicating its title, surrounded by square brackets. Below is a detailed description of the different sections and their contents:

{anchor:config_basic}
h6. Section {{basic}}

* {{admin}}: enables admin mode ({{True\|False}})
** *False*: By default, the user will only be allowed to make recordings. Galicaster will operate as a [Galicaster Class|Galicaster:Galicaster Class]
*** In this mode, tracks are selectable, so only the selected ones will be send back to the server.
** *True*: Apart from recording, the user can edit metadata, play and manage the recordings. Galicaster will behave as a [Galicaster Mobile|Galicaster Mobile]
*** In this mode Matterhorn server won't receive a list of tracks, so all tracks specified will be recorded, packaged and send back to the server.
** Depending on the mode, the capture unit will assume a different capture agent name. A computer named Example will gcExample on Class mode and gcMobileEXample on Mobile mode. The agent name can be set manually on ingest>hostname.
* {{repository}}: absolute path to the working folder. If not specified, a {{Repository}} directory in the user's home will be used.
* {{export}}: absolute path to the export folder for operations. If not specified, exported files will be placed at the user's home folder.
* {{stopdialog}}: Enable/Disable a dialog requesting confirmation to stop the recording. Defaults to True. *(True|False)*
* {{quit}}: Shows or hides the quit button. *(True|False)*

Example:
{code:none}
[basic]
admin = True
repository = /mnt/videos/Repository
export = /home/user/Videos
stopdialog = True
quit = True

{code}

{anchor:config_screen}
h6. Section {{screen}}

* {{right}}: Name of the video device in the [track list|#config_track] to be shown in the right screen ({{None}} to deactivate).
* {{left}}: Name of the video device in the [track list|#config_track] to be shown in the left screen ({{None}} to deactivate).

Note that if a profile different from default is selected, they will be ordered automatically via track position

* Example:
{code:none}
[screen]
right = Epiphan
left = Hauppauge
{code}

{anchor:config_ingest}
h6. Section {{ingest}}

* {{active}}: Enables the connection to a Opencast-Matterhorn server *(True|False)*.
* {{manua}}l: Configure the method to automatically ingest the manual recordings. The possible options are: disable the automatic ingestion (none), ingest immediately after the recording (immediately) or ingest nightly all the recordings of the previous day (nightly). Defaults to 'none'. *(none|immediately|nightly)*
* {{scheduled}}: Configure the method to automatically ingest the scheduled recordings. The possible options are: disable the automatic ingestion (none), ingest immediately after the recording (immediately) or ingest nightly all the recordings of the previous day (nightly). Defaults to 'none'. *(none|immediately|nightly)*
* {{host}}: Matterhorn server URL.
* {{username: Name of the Galicaster unit. Defaults to the host name as defined in the OS, prepended by "GC-" if it is a Galicaster Class or "GCMobile-" if it is a Galicaster Mobile.
* {{password}}: Password for the account used to operate the Matterhorn REST endpoints service.
* {{hostname}}: Custom denomination of the galicaster unit. By default it's obtained from de operative system.
* {{workflow}}: name of the workflow used to ingest the recordings.
* {{workflow-parameters}}: pairs of parameter and value (parameter:value) to be parsed on the Matterhorn workflow, separated by semicolon.

Example:
{code:none}
[ingest]
active = False
manual = nightly
scheduled = immediately
host = http://fakeadmin.matterhorn.com:80
username = matterhorn_system_account
password = CHANGE_ME
workflow = full
workflow-parameters = trimHold:true
{code}

{anchor:config_allows}
h6. Section {{allows}}

* {{manual}}: Allows full manual control of the recordings. ({{True\|False}})
* {{start}}: If {{manual}} is false, recordings can be started manually. ({{True\|False}})
* {{stop}}: If {{manual}} is false, recordings can be stopped manually \-also the scheduled ones. ({{True\|False}})
* {{pause}}: Allows pausing a recording \-independently from the value of {{manual}}. ({{True\|False}})
* {{overlap}}: If activated, a manual recording takes priority over a scheduled one, meaning it will not stop when the scheduled one should start. Otherwise, the manual recording will be stopped and the scheduled one started.({{True\|False}})

Example:
{code:none}
[allows]
manual = True
start = False
stop = False
pause = True
overlap = False
{code}

{anchor:config_track}
h6. Section {{trackN}}


A section per device used in the capturer. Each section is set according to the device type: {{hauppauge}}, {{pulse}}, {{v4l2}} or {{vga2usb}}:

{anchor:v4l2}
*v4l2*: Video device
* Admitted values:
** {{name}}: Name assigned to the device.
** {{device}}: Device type: v4l2
** {{flavor}}: Matterhorn "flavor" associated to the track. ({{presenter\|presentation\|other}})
** {{location}}: Device's mount point in the system (e.g. /dev/video0).
** {{file}}: The file name where the track will be recorded.
** {{videocrop}}: Margin in pixels to be cutted. Useful to set a 4:3 proportion on a HD webcam.{{videocrop-top}}, {{videocrop-bottom,}} {{videocrop-left, videocrop-right}} (optional).
** {{active}}: Whether the device will be played and recorded. ({{True\|False}})
** {{caps: }} GStreamer cappabilities of the device ({{mimetype=TYPE, framerate=X/Y,width=A,height=B}})

TYPE: ({{image/jpeg}} \| {{video/x-raw-yuv}})
Use GVUCView tool to know wich capabilities are compatible with your device
For more information  [http://pygstdocs.berlios.de/pygst-tutorial/capabilities.html|http://pygstdocs.berlios.de/pygst-tutorial/capabilities.html]

Example:
{code:none}
[track1]
name = Webcam
device = v4l2
flavor = presenter
location = /dev/webcam
file = WEBCAM.avi
active = False
caps = image/jpeg,framerate=25/1,width=1280,height=720
videocrop-left = 160
videocrop-right = 160
{code}

{anchor:vga2usb}
*vga2usb*: Video device
** Admitted values:
** {{name}}: Name assigned to the device.
** {{device}}: Device type: vga2usb
** {{flavor}}: Matterhorn "flavor" associated to the track. ({{presenter\|presentation\|other}})
** {{location}}: Device's mount point in the system (e.g. /dev/video0).
** {{file}}: The file name where the track will be recorded.
** {{active}}: Whether the device will be played and recorded. ({{True\|False}})
** {{drivertype}}: Wheter the device use a v4l or a v4l2 interface to guarantee compatibility ({{v4l\|v4l2}})
As for Ubuntu 10.10 (recommended OS) use {{v4l}}.

Example:
{code:none}
[track2]
name = Epiphan
device = vga2usb
flavor = presentation
location = /dev/screen
file = SCREEN.avi
active = True
drivertype = v4l
{code}

{anchor:pulse}
*pulse*: Audio device.
* Admitted values:
** {{name}}: Name assigned to the device.
** {{device}}: Device type: pulse
** {{flavor}}: Matterhorn "flavor" associated to the track. ({{presenter\|presentation\|other}})
** {{location}}: PulseAudio source name. Use _default_ to select the same Input as the Sound Control
** {{file}}: The file name where the track will be recorded.
** {{vumeter}}: Activates data sending to the program's vumeter. ({{True\|False}}) Only one device should be activated.
** {{amplification}}: Gstreamer amplification value: < 1 decreases and > 1 increases volume. Values between 1 and 2 are commonly used.
** {{active}}: Whether the device will be played and recorded. ({{True\|False}})

* to list PulseAudio devices run:
{code:none}
$ pactl list | grep "Source" -A 5
{code}
and use "Name:" as the {{location}} field.

Example:
{code:none}
[track3]
name = AudioSource
device = pulse
flavor = presenter
location = default
file = sound.mp3
active = False
vumeter = Active
amplification = 2.0
{code}

{anchor:blackmagic}
*blackmagic*: Video device
* Admitted values:
** {{name}}: Name assigned to the device.
** {{device}}: Device type: blackmagic
** {{flavor}}: Matterhorn "flavor" associated to the track. ({{presenter\|presentation\|other}})
** {{file}}: The file name where the track will be recorded.
** {{input}}: Input signal format. (sdi\|hdmi\|opticalsdi\|component\|composite\|svideo)
** {{input-mode}}: Input vidoe mode and framerate (1-20). More information [here|Galicaster:Blackmagic cards].
** {{active}}: Whether the device will be played and recorded. ({{True\|False}})

Example:
{code:none}
[track4]
name = BlackmagicSDI
device = blackmagic
flavor = presenter
file = CAMERA.avi
active = True
input = sdi
input-mode = 4
{code}

{anchor:hauppauge}
*hauppauge*: Audio and Video device with MPEG HW encoding
* Admitted values:
** {{name}}: Name assigned to the device.
** {{device}}: Device type: hauppauge
** {{flavor}}: Matterhorn "flavor" associated to the track. ({{presenter\|presentation\|other}})
** {{location}}: Device's mount point of the MPEG output
** {{locprevideo}}: Device's mount point of the RAW output
** {{locpreaudio}}: Device's mount point of the PCM output
** {{file}}: The file name where the track will be recorded.
** {{vumeter}}: Whether the audio input would be represented on the vumeter. (True|False)
** {{player}}: Whether the audio input would be played on preview. (True|False)
** {{active}}: Whether the device will be played and recorded. ({{True\|False}})

Example:
{code:none}
[track5]
name = Hauppauge
device = hauppauge
flavor = presenter
location = /dev/haucamera
locpreavideo = /dev/hauprevideo
locpreaudio = /dev/haupreaudio
file = CAMERA.mpg
vumeter = True
player = True
{code}

*firewire*: Video and audio device.
* Admmited values:
** name: Name assigned to the device.
** device: Device type: blackmagic
** flavor: Matterhorn "flavor" associated to the track. (presenter|presentation|other)
** location: Device's mount point in the system (e.g. /dev/video0).
** file: The file name where the track will be recorded.
** format: Input signal format. (dv|hdv,iidc)
** vumeter: Activates data sending to the program's vumeter. (True|False) Only one device should be activated.
** player: Whether the audio input would be played on preview. (True|False)

Example:
{code:none}
[track6]
name = Firewire
device = firewier
flavor = presenter
location = /dev/
file = CAMERA.dv
format = dv
vumeter = True
player = True
{code}

{anchor:videotest}
*videotest*: Mock video device.
* Admmited values:
** name: Name assigned to the device.
** device: Device type: videotest
** flavor: Matterhorn "flavor" associated to the track. (presenter|presentation|other)
** location: Device's mount point in the system (e.g. /dev/video0).
** file: The file name where the track will be recorded.
** active: Whether the device will be played and recorded. (True|False)
** caps: GStreamer capabilities of the device.
** pattern: type of pattern to show. Run gst-inspect-0.10 videotestsrc fore more information. (0-20)
** color1: pattern foreground color, indicated on Big endian ARGB. Run gst-inspect-0.10 videotestsrc fore more information. (0,4294967495)
** color2: pattern background color, indicated on Big endian ARGB. Run gst-inspect-0.10 videotestsrc fore more information. (0,4294967495)

* Pattern options
(0): smpte - SMPTE 100% color bars
(1): snow - Random (television snow)
(2): black - 100% Black
(3): white - 100% White
(4): red - Red
(5): green - Green
(6): blue - Blue
(7): checkers-1 - Checkers 1px
(8): checkers-2 - Checkers 2px
(9): checkers-4 - Checkers 4px
(10): checkers-8 - Checkers 8px
(11): circular - Circular
(12): blink - Blink
(13): smpte75 - SMPTE 75% color bars
(14): zone-plate - Zone plate
(15): gamut - Gamut checkers
(16): chroma-zone-plate - Chroma zone plate
(17): solid-color - Solid color
(18): ball - Moving ball
(19): smpte100 - SMPTE 100% color bars
(20): bar - Bar

{anchor:audiotest}
*audiotest*: Mock audio device.
* Admitted values:
** name: Name assigned to the device.
** device: Device type: pulse
** flavor: Matterhorn "flavor" associated to the track. (presenter|presentation|other)
** location: PulseAudio source name. Use default to select the same Input as the Sound Control. To list PulseAudio devices run:
{code:none}
pactl list | grep "Source" -A 5` and use "Name:" as the location field.
{code}
** file: The file name where the track will be recorded.
** wave: Generated waveform sample. Run gst-inspect-0.10 audiotestsrc fore more information. (0-12)
** frequency: Test signal central frequency. (0-20000)
** volume: Percent volume of the pattern. (0-1)
** active: Whether the device will be played and recorded. (True|False)
** vumeter: Activates data sending to the program's vumeter. (True|False) Only one device should be activated.
** amplification: Gstreamer amplification value: < 1 decreases and > 1 increases volume. Values between 1 and 2 are commonly used. (0-10)
** player: Whether the audio input would be played on preview. (True|False)

* Wave options
(0): sine - Sine
(1): square - Square
(2): saw - Saw
(3): triangle - Triangle
(4): silence - Silence
(5): white-noise - White uniform noise
(6): pink-noise - Pink noise
(7): sine-table - Sine table
(8): ticks - Periodic Ticks
(9): gaussian-noise - White Gaussian noise
(10): red-noise - Red (brownian) noise