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

* Moved the contents of 'docs/WINGS_FILTER.txt' to the
	Operation Guide.
This commit is contained in:
Fred Gleason 2017-11-06 15:13:39 -05:00
parent 6ede0bfb03
commit 0575739834
7 changed files with 134 additions and 70 deletions

View File

@ -16273,3 +16273,6 @@
2017-11-06 Fred Gleason <fredg@paravelsystems.com>
* Moved the contents of 'docs/RIVENDELL_FILTER.txt' to the
Operation Guide.
2017-11-06 Fred Gleason <fredg@paravelsystems.com>
* Moved the contents of 'docs/WINGS_FILTER.txt' to the
Operation Guide.

View File

@ -38,8 +38,7 @@ EXTRA_DIST = ALSA.txt\
reports.txt\
SAGE_ENDEC.txt\
scheduler_formats.ods\
WIN32.txt\
WINGS_FILTER.txt
WIN32.txt
CLEANFILES = *~

View File

@ -1,67 +0,0 @@
Usage Notes for the 'wings_filter' Import Script.
Wings_filter is a script designed to be used to import existing audio
and meta-data from an AirForce 'Wings' automation system. It is
invoked as follows:
USAGE
wings_filter -g <default-group> -d <db-file> -A <audio-dir> [-e <audio-ext>]
Where:
<default-group> = The name of the group in which to place carts
belonging to a source tab in Wings for which there
is no corresponding Rivendell Group.
<db-file> = The name of the Wings database file.
<audio-dir> = The name of the directory containing the Wings ATX
audio files.
<audio-ext> = The filetype extension fo the Wings ATX files. By
default, this is 'ATX', but can be changed to
other values here if necessary.
OVERVIEW
In order import audio from an existing Wings system, proceed as
follows:
1) CREATE RIVENDELL GROUPS
In RDAdmin->ManageGroups, create a Group to correspond to each Wings
Tab value that exists in the library to be imported, and an additional
group to catch any Wings entries that may not have a valid Group.
When creating these groups, it is essential that a default cart number
range be configured for each group that is large enough to accomodate
all anticipated imports.
2) LOCATE THE 'WINGS' DATABASE AND AUDIO FILES
These can be mounted from a remote system if needs be. Read-only
access is adequate, 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 to accomodate the audio to be imported. You should have at
least the amount of space currently occupied by the Wings ATX 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.
5) CLEAN UP
If desired, use RDAdmin->ManageGroups to rename the single-letter
import groups to more intuitive names.
NOTE ON AUDIO PROCESSING
Wings_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 Rivendell *exactly* as it exists in the Wings 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.

View File

@ -24,6 +24,7 @@ OPSGUIDE_HTML = appendix.filepath_wildcards.html\
appendix.gplv2.html\
appendix.metadata_wildcards.html\
appendix.rivendell_filter.html\
appendix.wings_filter.html\
chapter.overview.html\
chapter.rdairplay.html\
chapter.rdcatch.html\
@ -199,6 +200,7 @@ OPSGUIDE_DEPS = $(OPSGUIDE_IMAGES) \
rdlogin.xml\
rdlogmanager.xml\
rivendell_filter.xml\
wings_filter.xml\
rml.xml\
utilities.rmlsend_screenshot.png\
utilities.xml\

View File

@ -17,6 +17,7 @@
<!ENTITY filepath_wildcards SYSTEM "filepath_wildcards.xml">
<!ENTITY metadata_wildcards SYSTEM "metadata_wildcards.xml">
<!ENTITY rivendell_filter SYSTEM "rivendell_filter.xml">
<!ENTITY wings_filter SYSTEM "wings_filter.xml">
]>
<book xmlns="http://docbook.org/ns/docbook" version="5.0">
@ -36,6 +37,7 @@
&filepath_wildcards;
&metadata_wildcards;
&rivendell_filter;
&wings_filter;
</book>
<!--

View File

@ -0,0 +1,126 @@
<appendix xmlns="http://docbook.org/ns/docbook" xml:id="appendix.wings_filter">
<title>Wings Filter</title>
<sect1 xml:id="sect.wings_filter.overview">
<title>Overview</title>
<para>
Wings Filter is a script designed to be used to import existing audio
and meta-data from an AirForce 'Wings' automation system.
</para>
</sect1>
<sect1 xml:id="sect.wings_filter.usage">
<title>Usage</title>
<para>
<command>wings_filter
<arg choice="req">-g <replaceable>default-group</replaceable></arg>
<arg choice="req">-d <replaceable>db-file</replaceable></arg>
<arg choice="req">-A <replaceable>audio-dir</replaceable></arg>
<arg choice="opt">-e <replaceable>audio-ext</replaceable></arg>
</command>
</para>
<variablelist>
<varlistentry>
<term>-g <replaceable>default-group</replaceable></term>
<listitem>
<para>
The name of the group in which to place carts
belonging to a source tab in Wings for which there
is no corresponding destination Group.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-d <replaceable>db-file</replaceable></term>
<listitem>
<para>
The path to the Wings database file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-A <replaceable>audio-dir</replaceable></term>
<listitem>
<para>
The path to the directory containing the Wings ATX
audio files.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-s <replaceable>audio-ext</replaceable></term>
<listitem>
<para>
The filetype extension fo the Wings ATX files. By
default, this is 'ATX', but can be changed to
other values here if necessary.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 xml:id="sect.wings_filter.procedure">
<title>Procedure</title>
<para>
In order import audio from an existing Wings system, proceed as
follows:
</para>
<sect2 xml:id="sect.wings_filter.procedure.create_rivendell_groups">
<title>Create Rivendell Groups</title>
<para>
In RDAdmin->ManageGroups, create a Group to correspond to each Wings
Tab value that exists in the library to be imported, and an additional
group to catch any Wings entries that may not have a valid Group.
When creating these groups, it is essential that a default cart number
range be configured for each group that is large enough to accomodate
all anticipated imports.
</para>
</sect2>
<sect2 xml:id="sect.wings_filter.procedure.locate_the__wings__database_and_audio_files">
<title>Locate the 'Wings' Database and Audio Files</title>
<para>
These can be mounted from a remote system if needs be. Read-only
access is adequate, as the script does not modify these items in any
way.
</para>
</sect2>
<sect2 xml:id="sect.wings_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 to accomodate the audio to be imported. You should have at
least the amount of space currently occupied by the Wings ATX files,
plus 5 percent additional.
</para>
</sect2>
<sect2 xml:id="sect.wings_filter.procedure.invoke_script">
<title>Invoke Script</title>
<para>
Start up the script, as described in
<xref linkend="wings_filter.usage" />. The script will print progress
reports as it proceeds, or notify you of
error conditions as required.
</para>
</sect2>
<sect2 xml:id="sect.wings_filter.procedure.clean_up">
<title>Clean Up</title>
<para>
If desired, use RDAdmin->ManageGroups to rename the single-letter
import groups to more intuitive names.
</para>
</sect2>
<caution xml:id="caution.wings_filter.procedure.note_on_audio_processing">
<title>Note on Audio Processing</title>
<para>
Wings 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 Rivendell *exactly* as it exists in the Wings 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>
</sect1>
</appendix>

View File

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