mirror of
https://github.com/ElvishArtisan/rivendell.git
synced 2025-05-30 07:32:32 +02:00
2017-11-03 Fred Gleason <fredg@paravelsystems.com>
* Removed 'docs/ENCODERS.txt'. * Removed 'docs/implemented_macros.txt'. * Removed 'docs/JACK.txt'.
This commit is contained in:
Fred Gleason
parent
e0a86cbd83
commit
d04d33fafa
@ -16233,3 +16233,7 @@
|
||||
* Moved the contents of 'docs/SWITCHERS.txt' to the Operations Guide.
|
||||
2017-11-03 Fred Gleason <fredg@paravelsystems.com>
|
||||
* Moved the contents of 'docs/GPIO.txt' to the Operations Guide.
|
||||
2017-11-03 Fred Gleason <fredg@paravelsystems.com>
|
||||
* Removed 'docs/ENCODERS.txt'.
|
||||
* Removed 'docs/implemented_macros.txt'.
|
||||
* Removed 'docs/JACK.txt'.
|
||||
|
||||
@ -1,93 +0,0 @@
|
||||
File Exporting and Encoders in Rivendell
|
||||
|
||||
Rivendell has the capability to export audio in many different formats using
|
||||
several different modules (RDLibrary, RDCatch and RDCastManager). To
|
||||
accomplish this, Rivendell uses audio *encoder* objects, each of which enable
|
||||
one or more particular 'export formats'. A list of all
|
||||
recognized export formats for each host can be found by looking in
|
||||
RDAdmin->ManageHosts->AudioResources, under 'Supported Export Formats'.
|
||||
|
||||
Encoders in Rivendell come in two different basic types, "built-in", and
|
||||
"custom". Each type is discussed separately below.
|
||||
|
||||
|
||||
BUILT-IN ENCODERS
|
||||
Some built-in encoders are enabled automatically as part of the basic
|
||||
Rivendell installation process, while others require one or more external
|
||||
library packages in order to be recognized and used. The following chart
|
||||
shows the dependencies:
|
||||
|
||||
FORMAT REQUIRED PACKAGE(S) AVAILABLE AT
|
||||
-------------------------------------------------------------------------
|
||||
Linear PCM16 [included]
|
||||
MPEG 1,2 Layer 2 [included]
|
||||
MPEG 1,2 Layer 3 Lame http://lame.sourceforge.net
|
||||
FLAC Flac http://flac.sourceforge.net
|
||||
OggVorbis LibOgg, LibVorbis http://www.vorbis.com
|
||||
|
||||
|
||||
CUSTOM ENCODERS
|
||||
It is possible to configure a Rivendell host to export audio in a format not
|
||||
supported by one of the built-in encoders by configuring a 'custom' encoder.
|
||||
Generally, all that is needed is an encoder program that can be invoked from
|
||||
the Linux command-line. The configuration is done in
|
||||
RDAdmin->ManageHosts->CustomEncoders. Each encoder needs the following
|
||||
information:
|
||||
|
||||
NAME
|
||||
A unique-per-host name for the encoder.
|
||||
|
||||
DEFAULT EXTENSION
|
||||
A typically two- or three-letter long file extension to associate with this
|
||||
encoder.
|
||||
|
||||
COMMAND LINE
|
||||
The command line that Rivendell should invoke to encode a file. When invoked,
|
||||
Rivendell will pipe the source audio data into standard input of the program
|
||||
shown here, using sixteen-bit little-endian format with no headers (so-called
|
||||
'raw' mode) and with channelization and sample rate as indicated in the
|
||||
configuration for the specific export being executed. The following
|
||||
wildcard characters can be used to pass parameters from the specfic export
|
||||
configuration:
|
||||
|
||||
%f - Full destination path/name.
|
||||
%c - Number of channels
|
||||
%r - Sample rate, in samples/sec
|
||||
%b - Bitrate, in bits/sec
|
||||
|
||||
ALLOWABLE PARAMETERS
|
||||
Finally, each encoder can be provided with a list of zero or more 'allowed'
|
||||
values for Channel, Sample Rate and Bit Rate. Rivendell will use these values
|
||||
(along with the 'NAME' value, see above) to populate the approriate controls
|
||||
in the Edit Export Settings dialog. If no values are configured for a
|
||||
particular parameter, then the correponding control in the dialog will be
|
||||
shown as disabled ("greyed-out"), in which case it is assumed that the encoder
|
||||
being invoked either does not need the parameter or has had it hard-coded in
|
||||
the configured command line.
|
||||
|
||||
|
||||
EXAMPLE
|
||||
As an example, let's set up a custom encoder to produce 'Flash' encoded audio
|
||||
files using the FFmpeg multimedia transcoder (http://ffmpeg.mplayerhq.hu/) and
|
||||
the Freeware Advanced Audio Coder (http://sourceforge.net/projects/faac/).
|
||||
After installing these packages and verifying that Flash files can be
|
||||
successfully generated from the command line, we go into
|
||||
RDAdmin->ManageHosts->CustomEncoders, click the 'Add' button and fill out the
|
||||
name:
|
||||
|
||||
New Encoder Name: Flash AAC
|
||||
|
||||
Click 'Ok', and the Edit Encoder dialog will open. Fill out the parameters
|
||||
as follows:
|
||||
|
||||
Default Extension: flv
|
||||
Command Line: ffmpeg -y -vn -f s16le -ac %c -ar %r -i - -vn -f flv -acodec libfaac -ac %c -ar %r -ab %b %f
|
||||
Allow Channels: 1,2
|
||||
Allow Sample Rates: 22050,44100
|
||||
Allow Bit Rates: 8,16
|
||||
|
||||
Note that the bit rates here are specified in kbps!
|
||||
|
||||
Click 'OK' to save, then go to RDAdmin->ManageHosts->AudioResources. You
|
||||
should now see a 'Flash AAC [Custom]' entry in the 'SUPPORTED EXPORT FORMATS'
|
||||
list.
|
||||
110
docs/JACK.txt
110
docs/JACK.txt
@ -1,110 +0,0 @@
|
||||
JACK Support in Rivendell
|
||||
|
||||
Rivendell can optionally be compiled to provide full support for the
|
||||
JACK Audio Connection Kit. Instructions on enabling such support can
|
||||
be found in the INSTALL file. Information about JACK itself can be
|
||||
found at:
|
||||
|
||||
http://jackit.sourceforge.net/
|
||||
|
||||
|
||||
STARTING UP RIVENDELL WITH JACK
|
||||
When Rivendell's audio daemon, caed(8) is started, and JACK support is
|
||||
enabled, caed(8) will look for a running jackd(1). If it finds one,
|
||||
it will attempt to join the graph and create the following ports:
|
||||
|
||||
rivendell_<N>:capture_<M>L
|
||||
rivendell_<N>:capture_<M>R
|
||||
...
|
||||
rivendell_<N>:playout_<M>L
|
||||
rivendell_<N>:playout_<M>R
|
||||
...
|
||||
|
||||
where <N> is the number of the virtual 'card' Rivendell will use to
|
||||
access JACK, and <M> is the number of the virtual 'port' within that
|
||||
'card'. The card number is selected automatically by caed(8), and
|
||||
will be the first unused card number after any ASI adapters found in
|
||||
the system are initialized. The 'L' and 'R' stand for 'left' and
|
||||
'right' stereo channels, respectively. These card/port pairs can be
|
||||
assigned within RDAdmin just like any other Rivendell audio resource.
|
||||
|
||||
|
||||
JACK DAEMON MANAGEMENT
|
||||
On distros that use a SysV-ish init system (such as SuSE), it's
|
||||
possible to configure Rivendell to automatically start and stop the
|
||||
jackd(8) daemon as needed. To do this, proceed as follows:
|
||||
|
||||
On SuSE
|
||||
Fire up Yast2, click 'System' and then select 'Editor for
|
||||
/etc/sysconfig Files'. Under 'Configuration Options', select
|
||||
'Applications' and then 'Rivendell'. Configure the parameters there
|
||||
as desired, then click 'Finish' to save them.
|
||||
|
||||
Other Distros
|
||||
Edit the file '/etc/sysconfig/rivendell' and set the variables to
|
||||
the desired settings.
|
||||
|
||||
|
||||
JACK SESSION MANAGEMENT
|
||||
Simple session connection management is possible by placing entries
|
||||
within the [JackSession] section of /etc/rd.conf. The format is as
|
||||
follows:
|
||||
|
||||
[JackSession]
|
||||
Source<n>=<src-port>
|
||||
Destination<n>=<dest-port>
|
||||
|
||||
where:
|
||||
<n> = Arbitrary connection number, must start at '1' and go up
|
||||
consecutively.
|
||||
|
||||
<src-port> = The name of the source JACK port to connect, in
|
||||
standard CLIENTNAME:PORTNAME format.
|
||||
|
||||
<dest-port> = The name of the destination JACK port to connect, in
|
||||
standard CLIENTNAME:PORTNAME format.
|
||||
|
||||
Here is an example [JackSession] section:
|
||||
|
||||
[JackSession]
|
||||
Source1=rivendell_1:playout_0L
|
||||
Destination1=alsa_pcm:playback_1
|
||||
|
||||
Source2=rivendell_1:playout_0R
|
||||
Destination2=alsa_pcm:playback_2
|
||||
|
||||
Source3=rivendell_1:playout_1L
|
||||
Destination3=alsa_pcm:playback_3
|
||||
|
||||
Source4=rivendell_1:playout_1R
|
||||
Destination4=alsa_pcm:playback_4
|
||||
|
||||
Source5=rivendell_1:playout_2L
|
||||
Destination5=alsa_pcm:playback_9
|
||||
|
||||
Source6=rivendell_1:playout_2R
|
||||
Destination6=alsa_pcm:playback_10
|
||||
|
||||
Source7=alsa_pcm:capture_1
|
||||
Destination7=rivendell_1:record_0L
|
||||
|
||||
Source8=alsa_pcm:capture_2
|
||||
Destination8=rivendell_1:record_0R
|
||||
|
||||
Source9=alsa_pcm:capture_3
|
||||
Destination9=rivendell_1:record_1L
|
||||
|
||||
Source10=alsa_pcm:capture_4
|
||||
Destination10=rivendell_1:record_1R
|
||||
|
||||
Source11=alsa_pcm:capture_9
|
||||
Destination11=rivendell_1:record_2L
|
||||
|
||||
Source12=alsa_pcm:capture_10
|
||||
Destination12=rivendell_1:record_2R
|
||||
|
||||
This example sets up an ICE1712-based soundcard (a Midiman Delta-66,
|
||||
in this case) to use the first three playout and record ports of Card
|
||||
1 in Rivendell. It is, of course, fully possible to dynamically
|
||||
manage the port assignments through use of a JACK patchbay (such as
|
||||
QJackConnect) as well.
|
||||
@ -2,7 +2,7 @@
|
||||
##
|
||||
## docs/automake.am for Rivendell
|
||||
##
|
||||
## (C) Copyright 2002-2016 Fred Gleason <fredg@paravelsystems.com>
|
||||
## (C) Copyright 2002-2017 Fred Gleason <fredg@paravelsystems.com>
|
||||
##
|
||||
## This program is free software; you can redistribute it and/or modify
|
||||
## it under the terms of the GNU General Public License version 2 as
|
||||
@ -33,9 +33,6 @@ EXTRA_DIST = ALSA.txt\
|
||||
colors\
|
||||
copy_split_format.odt\
|
||||
datetime_wildcards.txt\
|
||||
implemented_macros.txt\
|
||||
ENCODERS.txt\
|
||||
JACK.txt\
|
||||
MESSAGE_BOX.txt\
|
||||
metadata_wildcards.txt\
|
||||
NEXGEN_FILTER.txt\
|
||||
|
||||
@ -1,48 +0,0 @@
|
||||
The following RMLs are currently implemented:
|
||||
|
||||
Binary Serial Out [BO]
|
||||
Clear Serial Trap [SC]
|
||||
Console Label [CL]
|
||||
Database Backup [DB]
|
||||
Execute [EX]
|
||||
Fire Salvo [FS]
|
||||
GPI Enable [GE]
|
||||
GPI Set [GI]
|
||||
GPO Set [GO]
|
||||
Insert Next [PX]
|
||||
Insert Serial Trap [SI]
|
||||
Load Log [LL]
|
||||
Load Panel [PE]
|
||||
Login [LO]
|
||||
Macro Timer [MT]
|
||||
Make Next [MN]
|
||||
Pause Panel [PU]
|
||||
Play Panel [PP]
|
||||
Push Button [PB]
|
||||
Record Start [RS]
|
||||
Record Stop [RR]
|
||||
Refresh Log [RL]
|
||||
Run Shell Command [RN]
|
||||
Select Widget [PW]
|
||||
Send Command [CC]
|
||||
Serial Output [SO]
|
||||
Set Label [LB]
|
||||
Set Color Label [LC]
|
||||
Set Default Now & Next Cart [SN]
|
||||
Set Mode [PM]
|
||||
Sleep [SP]
|
||||
Start [PL]
|
||||
Start Next [PN]
|
||||
Stop [PS]
|
||||
Stop Panel [PT]
|
||||
Switch Add [SA]
|
||||
Switch Add With Gain [SG]
|
||||
Switch Crosspoint Gain [SX]
|
||||
Switch Level [SL]
|
||||
Switch Reload [SZ]
|
||||
Switch Remove [SR]
|
||||
Switch Take [ST]
|
||||
UDP Out [UO]
|
||||
|
||||
For a full description of Rivendell Macro Langauge commands, see the
|
||||
file 'rml.sxw'.
|
||||
@ -377,8 +377,6 @@ rm -rf $RPM_BUILD_ROOT
|
||||
%doc docs/catchd.txt
|
||||
%doc docs/colors
|
||||
%doc docs/ripc.txt
|
||||
%doc docs/JACK.txt
|
||||
%doc docs/ENCODERS.txt
|
||||
%doc docs/pam_rd.txt
|
||||
%doc docs/MESSAGE_BOX.txt
|
||||
%doc docs/docbook/cae.pdf
|
||||
@ -427,7 +425,6 @@ rm -rf $RPM_BUILD_ROOT
|
||||
%doc conf/rlm_urlwrite.conf
|
||||
%doc conf/rlm_spinitron_plus.conf
|
||||
%doc conf/rlm_tagstation.conf
|
||||
%doc docs/implemented_macros.txt
|
||||
%doc utils/sas_shim/rc.sas_shim
|
||||
%doc docs/datetime_wildcards.txt
|
||||
%doc docs/reports.txt
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user