Autres/Rivendellaudio
1
0
Fork 0
mirror of https://github.com/ElvishArtisan/rivendell.git synced 2025-07-13 15:17:44 +02:00
Code Issues Projects Releases Wiki Activity

2016-06-08 Fred Gleason <fredg@paravelsystems.com>

Browse Source 
* Translated the rdimport(1) manpage to DocBook-XML 5.
	* Translated the rdmarkerset(8) manpage to DocBook-XML 5.
This commit is contained in:
Fred Gleason 2016-06-08 11:51:43 -04:00
parent b33f1ea3df
commit ec1f6784cb
10 changed files with 989 additions and 460 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
ChangeLog
View File

@ -15211,3 +15211,6 @@
'rdadmin/test_import.cpp' and 'rdadmin/test_import.h'.
2016-06-07 Fred Gleason <fredg@paravelsystems.com>
* Incremented the package version to 2.13.0int01.
2016-06-08 Fred Gleason <fredg@paravelsystems.com>
* Translated the rdimport(1) manpage to DocBook-XML 5.
* Translated the rdmarkerset(8) manpage to DocBook-XML 5.

1
configure.ac
View File

@ -480,7 +480,6 @@ AC_CONFIG_FILES([rivendell.spec \
docs/Makefile \
docs/docbook/Makefile \
docs/examples/Makefile \
docs/man/Makefile \
docs/tables/Makefile \
debian/Makefile \
debian/patches/Makefile \

1
docs/Makefile.am
View File

@ -24,7 +24,6 @@ if DOCBOOK_AM
endif
SUBDIRS = $(DOCBOOK_AM_OPT) examples\
man\
tables
EXTRA_DIST = ALSA.txt\

8
docs/docbook/Makefile.am
View File

@ -33,23 +33,31 @@
all-local: cae.html\
cae.pdf\
rdmarkerset.8\
rdrevert.8\
rdexport.1\
rdimport.1\
rml.html\
rml.pdf\
web_api.html\
web_api.pdf
man_MANS = rdexport.1\
rdimport.1\
rdmarkerset.8\
rdrevert.8
EXTRA_DIST = cae.html\
cae.pdf\
cae.xml\
rdmarkerset.8\
rdmarkerset.xml\
rdrevert.8\
rdrevert.xml\
rdexport.1\
rdexport.xml\
rdimport.1\
rdimport.xml\
rml.html\
rml.pdf\
rml.xml\

48
docs/docbook/rdexport.xml
View File

@ -130,125 +130,125 @@
</para>
<variablelist>
<varlistentry>
<term>%a</term>
<term><userinput>%a</userinput></term>
<listitem>
<para>Artist</para>
</listitem>
</varlistentry>
<varlistentry>
<term>%b</term>
<term><userinput>%b</userinput></term>
<listitem>
<para>Record Label</para>
</listitem>
</varlistentry>
<varlistentry>
<term>%c</term>
<term><userinput>%c</userinput></term>
<listitem>
<para>Client</para>
</listitem>
</varlistentry>
<varlistentry>
<term>%e</term>
<term><userinput>%e</userinput></term>
<listitem>
<para>Agency</para>
</listitem>
</varlistentry>
<varlistentry>
<term>%g</term>
<term><userinput>%g</userinput></term>
<listitem>
<para>Rivendell group name</para>
</listitem>
</varlistentry>
<varlistentry>
<term>%h</term>
<term><userinput>%h</userinput></term>
<listitem>
<para>Event length in milliseconds</para>
</listitem>
</varlistentry>
<varlistentry>
<term>%i</term>
<term><userinput>%i</userinput></term>
<listitem>
<para>Cut Description</para>
</listitem>
</varlistentry>
<varlistentry>
<term>%j</term>
<term><userinput>%j</userinput></term>
<listitem>
<para>Cut Number</para>
</listitem>
</varlistentry>
<varlistentry>
<term>%l</term>
<term><userinput>%l</userinput></term>
<listitem>
<para>Album</para>
</listitem>
</varlistentry>
<varlistentry>
<term>%m</term>
<term><userinput>%m</userinput></term>
<listitem>
<para>Composer</para>
</listitem>
</varlistentry>
<varlistentry>
<term>%n</term>
<term><userinput>%n</userinput></term>
<listitem>
<para>Cart Number</para>
</listitem>
</varlistentry>
<varlistentry>
<term>%o</term>
<term><userinput>%o</userinput></term>
<listitem>
<para>Outcue</para>
</listitem>
</varlistentry>
<varlistentry>
<term>%p</term>
<term><userinput>%p</userinput></term>
<listitem>
<para>Publisher</para>
</listitem>
</varlistentry>
<varlistentry>
<term>%r</term>
<term><userinput>%r</userinput></term>
<listitem>
<para>Conductor</para>
</listitem>
</varlistentry>
<varlistentry>
<term>%s</term>
<term><userinput>%s</userinput></term>
<listitem>
<para>Song ID</para>
</listitem>
</varlistentry>
<varlistentry>
<term>%t</term>
<term><userinput>%t</userinput></term>
<listitem>
<para>Title</para>
</listitem>
</varlistentry>
<varlistentry>
<term>%u</term>
<term><userinput>%u</userinput></term>
<listitem>
<para>User Defined</para>
</listitem>
</varlistentry>
<varlistentry>
<term>%y</term>
<term><userinput>%y</userinput></term>
<listitem>
<para>Release Year</para>
</listitem>
@ -263,5 +263,17 @@
</variablelist>
</refsect1>
<refsect1 id='see_also'><title>See Also</title>
<para>
<citerefentry>
<refentrytitle>rdimport</refentrytitle><manvolnum>1</manvolnum>
</citerefentry>
<literal>,</literal>
<citerefentry>
<refentrytitle>rdmarkerset</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>
</para>
</refsect1>
</refentry>

814
docs/docbook/rdimport.xml Normal file
View File

@ -0,0 +1,814 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
Header
-->
<refmeta>
<refentrytitle>rdimport</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class='source'>June 2016</refmiscinfo>
<refmiscinfo class='manual'>Linux Audio Manual</refmiscinfo>
</refmeta>
<refnamediv>
<refname>rdimport</refname>
<refpurpose>
Audio importation tool for the Rivendell Radio Automation System
</refpurpose>
</refnamediv>
<info>
<author>
<personname>
<firstname>Fred</firstname>
<surname>Gleason</surname>
<email>fredg@paravelsystems.com</email>
</personname>
<contrib>Application Author</contrib>
</author>
</info>
<!--
Body
-->
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
<command>rdimport</command>
<arg choice='opt'><replaceable>OPTIONS</replaceable></arg>
<arg choice='req'><replaceable>group-name</replaceable></arg>
<arg choice='req'><replaceable>filespec</replaceable></arg>
<sbr/>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id='description'><title>Description</title>
<para>
<command>rdimport</command><manvolnum>1</manvolnum> is a command-line tool
for importing one or more audio files into the Rivendell Radio
Automation System. By default, a new cart will be created for each file
imported, although this behavior can be modified by use of the
appropriate options (see the <option>--single-cart</option>
and <option>--to-cart</option> options, below). A
<replaceable>filespec</replaceable> of <userinput>-</userinput> will
cause the list of filespecs to be read from standard input.
</para>
</refsect1>
<refsect1 id='options'><title>Options</title>
<variablelist remap='TP'>
<varlistentry>
<term>
<option>--add-scheduler-code=</option><replaceable>str</replaceable>
</term>
<listitem>
<para>
Add Scheduler Code <replaceable>str</replaceable> to the target
cart. The specified code must exist in RDAdmin->SchedulerCodes.
This option may be specified multiple times.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--autotrim-level=</option><replaceable>level</replaceable>
</term>
<listitem>
<para>
Specify the threshold level to use for autotrimming the audio,
in dBFS. Specifying <userinput>0</userinput> will turn off
autotrimming.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--cart-number-offset=</option><replaceable>offset</replaceable>
</term>
<listitem>
<para>
Add <replaceable>offset</replaceable> to the cart number as
determined from the metadata pattern or
<option>--use-cartchunk-cutid</option>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--clear-datetimes</option>
</term>
<listitem>
<para>
Do not set the cut start and end datetimes, even if such are
found in the file's import metadata. Mutually exclusive with the
<option>--set-datetimes</option> option.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--clear-daypart-times</option>
</term>
<listitem>
<para>
Do not set the cut start and end daypart times, even if such are
found in the file's import metadata. Mutually exclusive with the
<option>--set-daypart-times</option> option.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--create-enddate-offset=</option><replaceable>days</replaceable>
</term>
<listitem>
<para>
If the imported file does not reference an end date, create with
end date offset by <replaceable>days</replaceable> days relative
to the current date. Cannot be less than the value the value for
<option>--create-startdate-offset</option> (default =
<userinput>0</userinput>).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--create-startdate-offset=</option><replaceable>days</replaceable>
</term>
<listitem>
<para>
If the imported file does not reference an start date, create with
start date offset by <replaceable>days</replaceable> days relative
to the current date. Cannot be greater than the value the value for
<option>--create-enddate-offset</option> (default =
<userinput>0</userinput>).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--delete-cuts</option>
</term>
<listitem>
<para>
Delete all cuts within the destination cart before importing.
Use with caution!
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--delete-source</option>
</term>
<listitem>
<para>
Delete each source file after successful import. Use with caution!
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--drop-box</option>
</term>
<listitem>
<para>
Operate in DropBox mode, causing
<command>rdimport</command><manvolnum>1</manvolnum> to run
continuously, periodically scanning for files matching the
specified <replaceable>filespec</replaceable>, importing and then
deleting them when found. WARNING: use of this option also implies
the <option>--delete-source</option> option!
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--enddate-offset=</option><replaceable>days</replaceable>
</term>
<listitem>
<para>
If the imported file references an end date, offset the value by
<replaceable>days</replaceable> days.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--fix-broken-formats</option>
</term>
<listitem>
<para>
Attempt to work around malformed audio input data.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--help</option>
</term>
<listitem>
<para>
Print a short usage message and exit.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--log-mode</option>
</term>
<listitem>
<para>
Prepend date/time information to each line of printed status
(implies the <option>--verbose</option> option).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--metadata-pattern=</option><replaceable>pattern</replaceable>
</term>
<listitem>
<para>
Attempt to read metadata parameters from the source filename,
using the pattern <replaceable>pattern</replaceable>. Patterns
consist of a sequence of wildcards and regular characters to
indicate boundaries between metadata fields.
</para>
<para>
The available wildcards are:
</para>
<variablelist>
<varlistentry>
<term><userinput>%a</userinput></term>
<listitem>
<para>Artist</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>%b</userinput></term>
<listitem>
<para>Record Label</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>%c</userinput></term>
<listitem>
<para>Client</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>%e</userinput></term>
<listitem>
<para>Agency</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>%g</userinput></term>
<listitem>
<para>
Rivendell group name (overrides the
<replaceable>group-name</replaceable> parameter)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>%i</userinput></term>
<listitem>
<para>Cut Description</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>%l</userinput></term>
<listitem>
<para>Album</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>%m</userinput></term>
<listitem>
<para>Composer</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>%n</userinput></term>
<listitem>
<para>Cart Number</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>%o</userinput></term>
<listitem>
<para>Outcue</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>%p</userinput></term>
<listitem>
<para>Publisher</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>%r</userinput></term>
<listitem>
<para>Conductor</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>%s</userinput></term>
<listitem>
<para>Song ID</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>%t</userinput></term>
<listitem>
<para>Title</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>%u</userinput></term>
<listitem>
<para>User Defined</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>%y</userinput></term>
<listitem>
<para>Release Year</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>%%</userinput></term>
<listitem>
<para>A literal '%'</para>
</listitem>
</varlistentry>
</variablelist>
<para>
Detection of either the Rivendell Group [<userinput>%g</userinput>] or
Rivendell Cart [<userinput>%n</userinput>] will cause
<command>rdimport</command><manvolnum>1</manvolnum> to attempt to
import the file to the specified Group and/or Cart, overriding
whatever values were specified on the command line.
If the <option>--set-user-defined</option> option has been used,
then the value specified there will be used instead of
<userinput>%u</userinput>.
</para>
<para>
Boundaries between metadata fields are indicated by placing regular
characters between macros. For example, the pattern
<userinput>%t_%a_%g_%n.</userinput>, when processing a filename of
'My Song_My Artist_TEMP_123456.mp3',
would extract 'My Song' as the title and 'My Artist' as the artist,
while importing it into cart 123456 in the TEMP group.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--normalization-level=</option><replaceable>level</replaceable>
</term>
<listitem>
<para>
Specify the <replaceable>level</replaceable> to use for peak
normalizing the audio, in dBFS. Specifying <userinput>0</userinput>
will turn off normalization.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--segue-length=</option><replaceable>length</replaceable>
</term>
<listitem>
<para>
Length of the added segue in <replaceable>length</replaceable>
msecs. See <option>--segue-level</option>, below.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--segue-level=</option><replaceable>level</replaceable>
</term>
<listitem>
<para>
Specify the threshold <replaceable>level</replaceable> to use for
setting the segue start marker, in dBFS, as measured after any
specified normalization has been applied. Default action is not
to create segue markers.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--set-datetimes=</option><replaceable>start-datetime</replaceable>,<replaceable>end-datetime</replaceable>
</term>
<listitem>
<para>
Set the cut start and end datetimes, in the format YYYYMMDD-HHMMSS.
Mutually exclusive with <option>--clear-datetimes</option>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--set-daypart-times=</option><replaceable>start-time</replaceable>,<replaceable>end-time</replaceable>
</term>
<listitem>
<para>
Set the cut start and end datetimes, in the format HHMMSS.
Mutually exclusive with <option>--clear-daypart-times</option>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--set-marker-end-<replaceable>marker</replaceable>=</option><replaceable>offset</replaceable>
</term>
<listitem>
<para>
Set the <replaceable>marker</replaceable> end marker to a given
offset value, with <replaceable>offset</replaceable> specified in
milliseconds.
If positive, it is taken to indicate a marker position relative
to the absolute beginning of the audio cut, while if negative,
it is taken to indicate a marker position relative to the absolute
end of the audio cut.
</para>
<para>
The following <replaceable>marker</replaceable> values are recognized:
<variablelist>
<varlistentry>
<term><userinput>cut</userinput></term>
<listitem>
<para>The Cut markers</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>hook</userinput></term>
<listitem>
<para>The Hook markers</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>segue</userinput></term>
<listitem>
<para>The Segue markers</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>talk</userinput></term>
<listitem>
<para>The Talk markers</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--set-marker-fadedown=</option><replaceable>offset</replaceable>
</term>
<listitem>
<para>
Set the FadeDown marker to <replaceable>offset</replaceable>.
See the discussion of the
<option>--set-marker-end-<replaceable>marker</replaceable></option>
option above for a description of the
<replaceable>offset</replaceable> parameter.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--set-marker-fadeup=</option><replaceable>offset</replaceable>
</term>
<listitem>
<para>
Set the FadeUp marker to <replaceable>offset</replaceable>.
See the discussion of the
<option>--set-marker-end-<replaceable>marker</replaceable></option>
option above for a description of the
<replaceable>offset</replaceable> parameter.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--set-marker-start-<replaceable>marker</replaceable>=</option><replaceable>offset</replaceable>
</term>
<listitem>
<para>
Set the <replaceable>marker</replaceable> start marker to a given
offset value, with <replaceable>offset</replaceable> specified in
milliseconds. See the discussion of the
<option>--set-marker-end-<replaceable>marker</replaceable></option>
option above for a description of the
<replaceable>marker</replaceable> and
<replaceable>offset</replaceable> parameters.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--set-string-<replaceable>field</replaceable>=<replaceable>string</replaceable></option>
</term>
<listitem>
<para>
Set the cart label field <replaceable>field</replaceable> to
<replaceable>string</replaceable>. This will override any other
values --e.g. from <option>--metadata-pattern</option>.
</para>
<para>
Values recognized for <replaceable>field</replaceable> are:
<variablelist>
<varlistentry>
<term><userinput>agency</userinput></term>
<listitem>
<para>Agency Name</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>album</userinput></term>
<listitem>
<para>Album Name</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>artist</userinput></term>
<listitem>
<para>Artist Name</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>bpm</userinput></term>
<listitem>
<para>Beats per Minute (integer numeric)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>client</userinput></term>
<listitem>
<para>Client Name</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>composer</userinput></term>
<listitem>
<para>Composer Name</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>conductor</userinput></term>
<listitem>
<para>Conductor Name</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>description</userinput></term>
<listitem>
<para>Cut Description</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>label</userinput></term>
<listitem>
<para>Record Label Name (rights holder)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>outcue</userinput></term>
<listitem>
<para>Cut Outcue</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>publisher</userinput></term>
<listitem>
<para>Music Publisher (rights holder)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>song-id</userinput></term>
<listitem>
<para>Song ID</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>title</userinput></term>
<listitem>
<para>Title</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>user-defined</userinput></term>
<listitem>
<para>Miscelaneous Information</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>year</userinput></term>
<listitem>
<para>Year Released (four digit numeric)</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--set-user-defined=</option><replaceable>string</replaceable>
</term>
<listitem>
<para>
Deprecated. Use <option>--set-string-user-defined</option> instead.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--single-cart</option>
</term>
<listitem>
<para>
If more than one file is imported, place them within multiple cuts
within a single cart, rather than creating separate carts for each
file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--startdate-offset=</option><replaceable>days</replaceable>
</term>
<listitem>
<para>
If the imported file references a start date, add
<replaceable>days</replaceable> days to it.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--title-from-cartchunk-cutid</option>
</term>
<listitem>
<para>
Set the cart title from CartChunk CutID.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--to-cart=</option><replaceable>cartnum</replaceable>
</term>
<listitem>
<para>
Import into cart <replaceable>cartnum</replaceable>, rather than
using the next available cart number for the group. If the cart
does not exist, it will be created. Each file will be imported
into a separate new cut within the cart. Use of this option
implies <option>--single-cart</option> and is mutually exclusive
with <option>--use-cartchunk-cutid</option>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--use-cartchunk-cutid</option>
</term>
<listitem>
<para>
Import the audio into the cart specified by the CartChunk CutID
parameter associated with the file. If the cart does not exist,
it will be created. Use of this option is mutually exclusive
with <option>--to-cart</option>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--verbose</option>
</term>
<listitem>
<para>
Print progress messages during processing.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--version</option>
</term>
<listitem>
<para>
Output version information and exit.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>NOTES</title>
<para>
It may be necessary to enclose individual
<replaceable>filespec</replaceable> clauses in quotes in order to
protect wildcard characters from expansion by the shell. A typical
indicator that this is necessary is the failure of
<command>rdimport</command><manvolnum>1</manvolnum> to process newly
added files when running in DropBox mode.
</para>
</refsect1>
<refsect1>
<title>BUGS</title>
<para>
It could be argued that RMS rather than peak normalization would be
more appropriate for use with the <option>--normalization-level</option>
option.
</para>
</refsect1>
<refsect1 id='see_also'><title>See Also</title>
<para>
<citerefentry>
<refentrytitle>rdexport</refentrytitle><manvolnum>1</manvolnum>
</citerefentry>
<literal>,</literal>
<citerefentry>
<refentrytitle>rdmarkerset</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>
</para>
</refsect1>
</refentry>

134
docs/docbook/rdmarkerset.xml Normal file
View File

@ -0,0 +1,134 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
Header
-->
<refmeta>
<refentrytitle>rdmarkerset</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class='source'>June 2016</refmiscinfo>
<refmiscinfo class='manual'>Linux Audio Manual</refmiscinfo>
</refmeta>
<refnamediv>
<refname>rdmarkerset</refname>
<refpurpose>Tool for mass altering Rivendell audio cut markers</refpurpose>
</refnamediv>
<info>
<author>
<personname>
<firstname>Fred</firstname>
<surname>Gleason</surname>
<email>fredg@paravelsystems.com</email>
</personname>
<contrib>Application Author</contrib>
</author>
</info>
<!--
Body
-->
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
<command>rdmarkerset</command>
<arg choice='opt'><replaceable>OPTIONS</replaceable></arg>
<sbr/>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id='description'><title>Description</title>
<para>
<command>rdmarkerset</command><manvolnum>8</manvolnum> is a command-line
tool for setting or altering audio cut markers in the Rivendell Radio
Automation System.
</para>
</refsect1>
<refsect1 id='options'><title>Options</title>
<variablelist remap='TP'>
<varlistentry>
<term>
<option>--all-groups</option>
</term>
<listitem>
<para>
Apply marker changes to ALL audio cuts in the Library.
Use of this option is mutually exclusive with the
<userinput>--group</userinput> option, below. Use with caution!
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--auto-segue=</option><replaceable>level</replaceable>
</term>
<listitem>
<para>
Set the Segue Start marker on the specified cuts to
<replaceable>level</replaceable> dBFS and the Segue End marker
to the position of the End marker. Specifying a
<userinput>0</userinput> for <replaceable>level</replaceable>
will remove the segue markers. Default action is to leave the
segue markers unaltered.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--auto-trim=</option><replaceable>level</replaceable>
</term>
<listitem>
<para>
Auto-trim the specified cuts to <replaceable>level</replaceable>
dBFS. Specifying a <userinput>0</userinput> for
<replaceable>level</replaceable> will remove auto-trim --i.e.
move the Start and End markers to the extreme start and end of
the audio data. Default action is to leave the Start and End
markers unaltered.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--group=</option><replaceable>group</replaceable>
</term>
<listitem>
<para>
Apply marker changes to the audio cuts belonging to
<replaceable>group</replaceable>. This option may be given
multiple times. Use of this option is mutually exclusive with
the <userinput>--all-groups</userinput> option, above.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--verbose</option>
</term>
<listitem>
<para>
Print messages to STDOUT describing progress.
</para>
</listitem>
</varlistentry>
</variablelist>
<refsect1 id='see_also'><title>See Also</title>
<para>
<citerefentry>
<refentrytitle>rdexport</refentrytitle><manvolnum>1</manvolnum>
</citerefentry>
<literal>,</literal>
<citerefentry>
<refentrytitle>rdimport</refentrytitle><manvolnum>1</manvolnum>
</citerefentry>
</para>
</refsect1>
</refsect1>
</refentry>

29
docs/man/Makefile.am
View File

@ -1,29 +0,0 @@
## automake.am
##
## docs/man Automake.am Rivendell
##
## by 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
## published by the Free Software Foundation.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public
## License along with this program; if not, write to the Free Software
## Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
##
## Use automake to process this into a Makefile.in
man_MANS = rdimport.1\
rdmarkerset.8
EXTRA_DIST = $(man_MANS)
CLEANFILES = *~
DISTCLEANFILES = moc_*
MAINTAINERCLEANFILES = *~\
Makefile.in

366
docs/man/rdimport.1
View File

@ -1,366 +0,0 @@
.TH rdimport 1 "February 2015" Linux "Rivendell Radio Automation System"
.SH NAME
rdimport \- Audio importation tool for the Rivendell Radio Automation System
.SH SYNOPSIS
rdimport [OPTIONS] <group-name> <filespec> [<filespec>]*
.SH DESCRIPTION
\fBRdimport\fP is a command-line tool for importing one or more audio files
into the Rivendell Radio Automation System. By default, a new cart will be
created for each file imported, although this behavior can be modified by
use of the appropriate options (see the \fB--single-cart\fP and
\fB--to-cart\fP options, below). A <\fIfilespec\fP> of '-' will cause the
list of filespecs to be read from standard input.
.SH OPTIONS
.TP
.B --add-scheduler-code=<\fIstr\fP>
Add Scheduler Code <\fIstr\fP> to the target cart. The specified
code must exist in RDAdmin->SchedulerCodes. This option may be
specified multiple times.
.TP
.B --autotrim-level=<level>
Specify the threshold level to use for autotrimming the audio, in dBFS.
Specifying '0' will turn off autotrimming.
.TP
.B --cart-number-offset=<\fIoffset\fP>
Add <\fIoffset\fP> to the cart number as determined from metadata pattern
or --use-cartchunk-cutid.
.TP
.B --clear-datetimes
Do not set the cut start and end datetimes, even if such are found in
the file's import metadata. Mutually exclusive with the \fB--set-datetimes\fP
option.
.TP
.B --clear-daypart-times
Do not set the cut start and end daypart times, even if such are found in
the file's import metadata. Mutually exclusive with the
\fB--set-daypart-times\fP option.
.TP
.B --create-enddate-offset=<\fIdays\fP>
If the imported file does not reference an end date, create with
end date offset by <\fIdays\fP> days relative to the current date.
Cannot be less than the value the value for \fB--create-startdate-offset\fP
(default = 0).
.TP
.B --create-startdate-offset=<\fIdays\fP>
If the imported file does not reference a start date, create with
startdate offset by <\fIdays\fP> days relative to the current date.
Cannot be greater than the value for \fB--create-enddate-offset\fP
(default = 0).
.TP
.B --delete-cuts
Delete all cuts within the destination cart before importing. Use
with caution!
.TP
.B --delete-source
Delete each source file after successful import. Use with caution!
.TP
.B --drop-box
Operate in DropBox mode, causing \fIrdimport(1)\fP to run continuously,
periodically scanning for files matching the specified <\fIfilespec\fP>,
importing and then deleting them when found. WARNING: use of this option
also implies the \fB--delete-source\fP option!
.TP
.B --enddate-offset=<days>
If the imported file references an end date, offset the value by <\fIdays\fP>
days.
.TP
.B --fix-broken-formats
Attempt to work around malformed audio input data.
.TP
.B --help
Print a short usage message and exit.
.TP
.B --log-mode
Prepend date/time information to each line of printed status (implies
the '--verbose' option).
.TP
.B --metadata-pattern=<\fIpattern\fP>
Attempt to read metadata parameters from the source filename, using
the pattern <\fIpattern\fP>. Patterns consist of a sequence of wildcards and
regular characters to indicate boundaries between metadata fields.
The available wildcards are:
.RS
.TP
%a
Artist
.TP
%b
Record Label
.TP
%c
Client
.TP
%e
Agency
.TP
%g
Rivendell Group (overrides the <\fIgroup-name\fP> parameter)
.TP
%i
Cut Description
.TP
%l
Album
.TP
%m
Composer
.TP
%n
Rivendell Cart Number
.TP
%o
Cut Outcue
.TP
%p
Publisher
.TP
%r
Conductor
.TP
%s
Song ID
.TP
%t
Title
.TP
%u
User Defined
.TP
%y
Release Year (four digit numeric)
.TP
%%
A literal '%'
.RE
.RE
Detection of either the Rivendell Group [%g] or Rivendell Cart [%n]
will cause RDImport to attempt to import the file to the specified Group
and/or Cart, overriding whatever values were specified elsewhere on the
command line. If the \fB--set-user-defined\fP option has been used,
then the value specified there will be used instead of %u.
Boundaries between metadata fields are indicated by placing regular
characters between macros. For example, the pattern '%t_%a_%g_%n.',
when processing a filename of 'My Song_My Artist_TEMP_123456.mp3',
would extract 'My Song' as the title and 'My Artist' as the artist,
while importing it into cart 123456 in the TEMP group.
.TP
.B --normalization-level=<\fIlevel\fP>
Specify the level to use for peak normalizing the audio, in dBFS.
Specifying '0' will turn off normalization.
.TP
.B --segue-length=<\fIlength\fP>
Length of the added segue in msecs. See \fB--segue-level\fP below.
.TP
.B --segue-level=<\fIlevel\fP>
Specify the threshold level to use for setting the segue markers, in dBFS,
as measured after any specified normalization has been applied. Default
action is not to create segue markers.
.TP
.B --set-datetimes=<\fIstart-datetime\fP>,<\fIend-datetime\fP>
Set the cut start and end datetimes, in the format YYYYMMDD-HHMMSS. Mutually
exclusive with \fB--clear-datetimes\fP.
.TP
.B --set-daypart-times=<\fIstart-time\fP>,<\fIend-time\fP>
Set the cut start and end daypart times, in the format HHMMSS. Mutually
exclusive with \fB--clear-daypart-times\fP.
.TP
.B --set-marker-end-<\fImarker\fP>=<\fIoffset\fP>
Set an end marker to a given offset value. The <\fIoffset\fP> parameter is
specified in milliseconds. If positive, it is taken to indicate a marker
position relative to the absolute beginning of the audio cut, while if
negative, it is taken to indicate a marker position relative to the absolute
end of the audio cut.
The following <\fImarker\fP> types are recognized:
.RS
.TP
.B cut
The Cut markers.
.TP
.B hook
The Hook markers.
.TP
.B segue
The Segue markers
.TP
.B talk
The Talk markers.
.RE
.RE
.TP
.B --set-marker-fadedown=<\fIoffset\fP>
Set the FadeDown marker to a given offset value. See the discussion of the
\fB--set-marker-end-<marker>\fP option above for a description of the
<\fIoffset\fP> parameter.
.TP
.B --set-marker-fadeup=<\fIoffset\fP>
Set the FadeUp marker to a given offset value. See the discussion of the
\fB--set-marker-end-<marker>\fP option above for a description of the
<\fIoffset\fP> parameter.
.TP
.B --set-marker-start-<\fImarker\fP>=<\fIoffset\fP>
Set a start marker to a given offset value. See the discussion of the
\fB--set-marker-end-<marker>\fP option above for a description of the
<\fImarker\fP> and <\fIoffset\fP> parameters.
.TP
.B --set-string-<\fIfield\fP>=<\fIstring\fP>
Set the cart label field <\fIfield\fP> to <\fIstring\fP>. This will override
any other values --e.g. from \fB--metadata-pattern\fP. Values recognized
for <\fIfield\fP> are:
.RS
.TP
.B agency
Agency Name
.TP
.B album
Album Name
.TP
.B artist
Artist Name
.TP
.B bpm
Beats per Minute (integer numeric)
.TP
.B client
Client Name
.TP
.B composer
Music Composer Name
.TP
.B conductor
Conductor Name
.TP
.B description
Cut Description
.TP
.B label
Record Label Name (rights holder)
.TP
.B outcue
Cut Outcue
.TP
.B publisher
Music Publisher (rights holder)
.TP
.B song-id
Song ID
.TP
.B title
Title
.TP
.B user-defined
Miscelaneous Information
.TP
.B year
Year Released (four digit numeric)
.RE
.RE
.TP
.B --set-user-defined=<\fIstr\fP>
Deprecated. Use the \fB--set-string-user-defined\fP option instead.
.TP
.B --single-cart
If more than one file is imported, place them within multiple cuts within a
single cart, rather than creating separate carts for each file.
.TP
.B --startdate-offset=<\fIdays\fP>
If the imported file references a start date, offset the value by <\fIdays\fP>
days.
.TP
.B --title-from-cartchunk-cutid
Set the cart title from CartChunk CutID.
.TP
.B --to-cart=<\fIcartnum\fP>
Specify the cart to import the audio into, rather than using the next
available cart number for the group. If the cart does not exist, it will
be created. Each file will be imported into a separate new cut within the
cart. Use of this option implies the \fB--single-cart\fP option as well,
and is mutually exclusive with the \fB--use-cartchunk-cutid\fP option.
.TP
.B --use-cartchunk-cutid
Import the audio into the cart specified by the CartChunk CutID parameter
associated with the file. If the cart does not exist, it will be
created. Use of this option is mutually exclusive with the \fB--to-cart\fP
option.
.TP
.B --verbose
Print progress messages during processing.
.TP
.B --version
Output version information and exit.
.SH NOTES
It may be necessary to enclose individual <\fIfilespec\fP> clauses in quotes
in order to protect wildcard characters from expansion by the shell. A typical
indicator that this is necessary is the failure of \fBrdimport(1)\fP to process
newly added files when running in DropBox mode.
.SH BUGS
It could be argued that RMS rather than peak normalization would be more
appropriate for use with the \fB--normalization-level\fP option.
.SH AUTHOR
Fred Gleason <fredg@paravelsystems.com>
.SH "SEE ALSO"
.BR rdmarkerset(8),
.BR http://www.cartchunk.org/

45
docs/man/rdmarkerset.8
View File

@ -1,45 +0,0 @@
.TH rdmarkerset 8 "February 2015" Linux "Rivendell Radio Automation System"
.SH NAME
rdmarkerset \- Tool for mass altering Rivendell audio cut markers
.SH SYNOPSIS
rdmarkerset [OPTIONS]
.SH DESCRIPTION
\fBRdmarkerset\fP is a command-line tool for setting or altering audio cut
markers in the Rivendell Radio Automation System.
.SH OPTIONS
.TP
.B --group=<\fIgroup\fP>
Apply marker changes to the audio cuts belonging to <\fIgroup\fP>. This
option may be given multiple times. Use of this option is mutually
exclusive with the \fB--all-groups\fP option, below.
.TP
.B --all-groups
Apply marker changes to ALL audio cuts in the Library. Use of this option
is mutually exclusive with the \fB--group\fP option, above. Use with caution!
.TP
.B --auto-trim=<\fIlevel\fP>
Auto-trim the specified cuts to the level indicated by <\fIlevel\fP> dBFS.
Specifying a '0' for <\fIlevel\fP> will remove auto-trim --i.e. move the
Start and End markers to the extreme start and end of the audio data.
Default action is to leave the Start and End markers unaltered.
.TP
.B --auto-segue=<\fIlevel\fP>
Set the Segue Start marker on the specified cuts to the level indicated
by <\fIlevel\fP> dBFS and the Segue End marker to the position of the End
marker. Specifying a '0' for <\fIlevel\fP> will remove the segue markers.
Default action is to leave the segue markers unaltered.
.TP
.B --verbose
Print messages to STDOUT describing progress.
.SH AUTHOR
Fred Gleason <fredg@paravelsystems.com>
.SH "SEE ALSO"
.BR rdimport(1)