2017-11-06 Fred Gleason <fredg@paravelsystems.com>

* Moved the contents of 'docs/RIVENDELL_FILTER.txt' to the
	Operation Guide.
This commit is contained in:
Fred Gleason 2017-11-06 14:43:49 -05:00
parent ea3d0e9b6a
commit 6ede0bfb03
7 changed files with 164 additions and 72 deletions

View File

@ -16270,3 +16270,6 @@
* Moved the contents of 'docs/ripc.txt' to 'docs/apis/ripc.xml.'
2017-11-06 Fred Gleason <fredg@paravelsystems.com>
* Removed 'docs/NEXGEN_FILTER.txt'.
2017-11-06 Fred Gleason <fredg@paravelsystems.com>
* Moved the contents of 'docs/RIVENDELL_FILTER.txt' to the
Operation Guide.

View File

@ -36,7 +36,6 @@ EXTRA_DIST = ALSA.txt\
PODCASTING.txt\
RDMONITOR.txt\
reports.txt\
RIVENDELL_FILTER.txt\
SAGE_ENDEC.txt\
scheduler_formats.ods\
WIN32.txt\

View File

@ -1,70 +0,0 @@
Usage Notes for the 'rivendell_filter' Import Script.
Rivendell_filter is a script designed to be used to import existing audio
and meta-data from another Rivendell system. It is invoked as follows:
USAGE
rivendell_filter -h <hostname> -u <username> -p <password> -A <audio-dir>
-g <default-group> -s <start-cartnum> -e <end-cartnum>
Where:
<hostname> = The MySQL hostname of the source Rivendell database.
<username> = The MySQL username of the source Rivendell database.
<password> = The MySQL password of the source Rivendell database.
<audio-dir> = The name of the directory containing the source
Rivendell audio files.
<default-group> = The name of the group in which to place carts
belonging to a source Group for which there
is no corresponding destination Group.
<start-cartnum> = The first cart in the range of those to be transferred.
<end-cartnum> = The last cart in the range of those to be trasnferred.
OVERVIEW
In order transfer carts from an external Rivendell system, proceed as
follows:
1) CREATE RIVENDELL GROUPS
In RDAdmin->ManageGroups, create a Group to correspond to each Rivendell
Group that exists in the library to be imported, and an additional
group to catch any carts that may not have a corresponding Group.
2) LOCATE THE EXTERNAL RIVENDELL DATABASE AND AUDIO FILES
The directory containing the audio files can be mounted from a remote
system if needs be. Read-only access is adequate (and in fact recommended),
as the script does not modify these items in any way.
3) VERIFY AVAILABLE DISK SPACE
Verify that enough disk space is available in the '/var/snd/'
directory of the destination system to accomodate the audio to be
imported. You should have at least the amount of space currently occupied
by the source files, plus 5 percent additional.
4) INVOKE SCRIPT
Start up the script, as described in the USAGE section above. The
script will print progress reports as it proceeds, or notify you of
error conditions as required.
WARNING
If a cart from the source system has the same number as one one the
destination, the destination cart (data and *all* audio) will be overwritten!
NOTE ON AUDIO PROCESSING
Rivendell_filter does not alter or reencode the audio sample data in any
way, and thus does *not* incurr any generation or transcoding loss of
quality. At the same time, this means that the incoming audio will be
brought into the new Rivendell system *exactly* as it exists in the
source system, with all parameters (e.g. sample rate, bit rate, level,
etc) unaltered. If you need to alter one or more of these parameters as
part of the import process, we suggest you use the RDImport script
instead.
NOTE ON GROUP ASSIGNMENTS
WARNING: Rivendell_filter makes no attempt to enforce group numbering rules!
If a group to which a given source cart belongs exists on the destination
system, the cart will be placed in that group, regardless of numbering rules.

View File

@ -23,6 +23,7 @@ OPSGUIDE_HTML = appendix.filepath_wildcards.html\
appendix.gpio_switcher_devices.html\
appendix.gplv2.html\
appendix.metadata_wildcards.html\
appendix.rivendell_filter.html\
chapter.overview.html\
chapter.rdairplay.html\
chapter.rdcatch.html\
@ -197,6 +198,7 @@ OPSGUIDE_DEPS = $(OPSGUIDE_IMAGES) \
rdlogedit.xml\
rdlogin.xml\
rdlogmanager.xml\
rivendell_filter.xml\
rml.xml\
utilities.rmlsend_screenshot.png\
utilities.xml\

View File

@ -16,6 +16,7 @@
<!ENTITY gpio_switcher_devices SYSTEM "gpio_switcher_devices.xml">
<!ENTITY filepath_wildcards SYSTEM "filepath_wildcards.xml">
<!ENTITY metadata_wildcards SYSTEM "metadata_wildcards.xml">
<!ENTITY rivendell_filter SYSTEM "rivendell_filter.xml">
]>
<book xmlns="http://docbook.org/ns/docbook" version="5.0">
@ -34,6 +35,7 @@
&gpio_switcher_devices;
&filepath_wildcards;
&metadata_wildcards;
&rivendell_filter;
</book>
<!--

View File

@ -0,0 +1,157 @@
<appendix xmlns="http://docbook.org/ns/docbook" xml:id="appendix.rivendell_filter">
<title>Rivendell Filter</title>
<sect1 xml:id="rivendell_filter.overview">
<title>Overview</title>
<para>
Rivendell_filter is a script designed to be used to import existing audio
and meta-data from another Rivendell system.
</para>
</sect1>
<sect1 xml:id="rivendell_filter.usage">
<title>Usage</title>
<para>
<command>rivendell_filter
<arg choice="req">-h <replaceable>hostname</replaceable></arg>
<arg choice="req">-u <replaceable>username</replaceable></arg>
<arg choice="req">-p <replaceable>password</replaceable></arg>
<arg choice="req">-A <replaceable>audio-dir</replaceable></arg>
<arg choice="req">-g <replaceable>default-group</replaceable></arg>
<arg choice="req">-s <replaceable>start-cartnum</replaceable></arg>
<arg choice="req">-e <replaceable>end-cartnum</replaceable></arg>
</command>
</para>
<variablelist>
<varlistentry>
<term>-h <replaceable>hostname</replaceable></term>
<listitem>
<para>
The MySQL hostname of the source Rivendell database.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-u <replaceable>username</replaceable></term>
<listitem>
<para>
The MySQL username of the source Rivendell database.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-p <replaceable>password</replaceable></term>
<listitem>
<para>
The MySQL password of the source Rivendell database.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-A <replaceable>audio-dir</replaceable></term>
<listitem>
<para>
The path to the directory containing the source
Rivendell audio files.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-g <replaceable>default-group</replaceable></term>
<listitem>
<para>
The name of the group in which to place carts
belonging to a source Group for which there
is no corresponding destination Group.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-s <replaceable>start-cartnum</replaceable></term>
<listitem>
<para>
The first cart in the range of those to be transferred.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-e <replaceable>hostname</replaceable></term>
<listitem>
<para>
The last cart in the range of those to be transferred.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 xml:id="rivendell_filter.procedure">
<title>Procedure</title>
<para>
In order transfer carts from an external Rivendell system, proceed as
follows:
</para>
<sect2 xml:id="rivendell_filter.procedure.create_rivendell_groups">
<title>Create Rivendell Groups</title>
<para>
In RDAdmin->ManageGroups, create a Group to correspond to each Rivendell
Group that exists in the library to be imported, and an additional
group to catch any carts that may not have a corresponding Group.
</para>
</sect2>
<sect2 xml:id="rivendell_filter.procedure.locate_the_external_rivendell_database_and_files">
<title>Locate the External Rivendell Database and Audio Files</title>
<para>
The directory containing the audio files can be mounted from a remote
system if needs be. Read-only access is adequate (and in fact
recommended), as the script does not modify these items in any way.
</para>
</sect2>
<sect2 xml:id="rivendell_filter.procedure.verify_available_disk_space">
<title>Verify Available Disk Space</title>
<para>
Verify that enough disk space is available in the '/var/snd/'
directory of the destination system to accomodate the audio to be
imported. You should have at least the amount of space currently
occupied by the source files, plus 5 percent additional.
</para>
</sect2>
<sect2 xml:id="rivendell_filter.procedure.invoke_script">
<title>Invoke Script</title>
<para>
Start up the script, as described in the USAGE section above. The
script will print progress reports as it proceeds, or notify you of
error conditions as required.
</para>
</sect2>
<warning>
<title>Duplicate Cart Numbers</title>
<para>
If a cart from the source system has the same number as one one the
destination, the destination cart (data and *all* audio) will be
overwritten!
</para>
</warning>
<caution>
<title>Note on Audio Processing</title>
<para>
Rivendell_filter does not alter or reencode the audio sample data in any
way, and thus does *not* incurr any generation or transcoding loss of
quality. At the same time, this means that the incoming audio will be
brought into the new Rivendell system *exactly* as it exists in the
source system, with all parameters (e.g. sample rate, bit rate, level,
etc) unaltered. If you need to alter one or more of these parameters as
part of the import process, we suggest you use the RDImport script
instead.
</para>
</caution>
<caution>
<title>Note on Group Assignments</title>
<para>
Rivendell_filter makes no attempt to enforce group numbering
rules! If a group to which a given source cart belongs exists on the
destination system, the cart will be placed in that group, regardless
of numbering rules.
</para>
</caution>
</sect1>
</appendix>

View File

@ -482,7 +482,6 @@ rm -rf $RPM_BUILD_ROOT
@LOCAL_PREFIX@/share/applications/rivendell-rddgimport.desktop
@LOCAL_PREFIX@/share/applications/rivendell-rddiscimport.desktop
%doc docs/WINGS_FILTER.txt
%doc docs/RIVENDELL_FILTER.txt
%doc scripts/engine_conv.py