Views
A view defines how annotations are rendered in the page. Each view has its specific attributes that can alter annotations' display and final HTML output. While all views come with basic default style, it is possible to change any visual aspect via CSS to fit custom needs. Because everyone will have different visual requirements, styling is entirely left to the document authors.
concordancer
The concordancer view displays a table of annotations and their cotext annotations. Attributes allow timerange and count limits, to extract only meaningful relative annotations. Configurable display to see each cotext annotation in its own column, or all combined into one clip.
- show-value (bool = true) Whether to display the annotation's text value
- show-video (bool = false) Whether to display the video clip of the processed annotation
- show-tier (bool = false) Whether to display the annotation's tier
- show-group (bool = false) Whether to display the annotation's group
- show-file (bool = false) Whether to display the annotation's file
- show-index (bool = false) Whether to display the index of each row
- video-with-cotext (bool = true) Whether to include cotext annotations in the video
- cotext (int = 1) Number of annotations to extract before and after the processed annotation
- cotext-before (int = cotext) Number of annotations to extract before the processed annotation
- cotext-after (int = cotext) Number of annotations to extract after the processed annotation
- cotext-video (bool = false) Whether to display a video for cotext annotations
- cotext-split (bool = false) Whether to display each cotext annotation in its own column
- max-time-diff (int = 60) Skip cotext annotations that are out of this range
- label-before (string = Before) Label for table header
- label-pivot (string = Pivot) Label for table header
- label-after (string = After) Label for table header
- label-index (string = ) Label for table header
- label-tier (string = Tier) Label for table header
- label-group (string = Group) Label for table header
- label-file (string = File) Label for table header
- label-none (string = ) Label for no matches
Input
- Array<Annotation>
<VIEW type="concordancer" max-time-diff="15" cotext="1">
...
</VIEW>
<VIEW type="concordancer" max-time-diff="15" cotext="2" show-video="true" video-with-cotext="false" cotext-split="true" cotext-video="true">
...
</VIEW>
density
The density view plots annotations as filled bars in a timeline, revealing interactions frequency and duration between tiers.
- group (bool = false) Whether to separate annotations based on their group instead of their file
- sequence (string) Separate annotations based on another tier's annotations (used as sequences)
- time-offset (bool = false) Whether to use files' time-offset
- time-collapse (number = 0) Number of seconds after which empty space is collapsed (0 = no collpase)
- zoom-factor (int = 100) Milliseconds to pixel factor
- show-alt-tiers (bool = false) Whether to display alternative tiers in the main table
- show-alt-tier-in-empty-cells (bool = false) Whether to display the alternative tier if the cell is empty
- show-value-on-hover (bool = false) Whether to display the annotation value on mouse over
- show-snap-on-hover (bool = false) Whether to display the video snapshot on mouse over
- show-video-on-click (bool = false) Whether to display the video player on click
- video-player-width (string = 300)
- video-player-height (string)
Input
- Array<Annotation>
<VIEW type="density" zoom-factor="500">
...
</VIEW>
density-timeline 🧪
The density timeline plots annotations as filled bars horizontally, revealing interactions frequency and duration between tiers. Flexible time collapsing options allow compacting empty space between annotations. Currently not compatible with alt-tiers.
- group (bool = false) Whether to separate annotations based on their group instead of their file
- sequence (string) Separate annotations based on another tier's annotations (used as sequences)
- relate-to-corpus (bool = false) Whether to show the whole corpus regardless of input selection
- time-offset (bool = false) Whether to use files' time-offset
- time-between (bool = false) Whether to show the time between separators
- time-collapse-threshold (number = 0) Number of seconds after which empty space is collapsed (0 = no collpase)
- time-collapse-display (string = show-duration) How the collapsed zone should look
- time-collapse-alt-display (string = compact) How the collapsed zone should look if it collapsed less than alt-display-threshold
- time-collapse-alt-display-threshold (number = 0) Number of seconds collapsed before which alt-display is used
- time-collapse-hide-first-start (bool = false) Whether to hide the first (starting) collapse, if any
- time-collapse-hide-each-start (bool = false) Whether to hide the first (starting) collapse of each group/column, if any
- time-collapse-hide-each-last (bool = false) Whether to hide the last collapse of each group/column, if any
- time-collapse-hide-borders (bool = false) Whether to hide the left and right borders of collapsed zones
- time-collapse-absolute-start (bool = false) Whether to show the duration of the first collapse of each group, as an absolute duration (relative to corpus beginning when time-offset is active)
- time-collapse-debug (bool = false) Whether to show the debug info of collapses
- zoom-factor (int = 100) Milliseconds to pixel factor (how many milliseconds one pixel will represent)
- color-values (bool = false) Whether to use CSS for specific values, colors defined in Style or as parameters
- color-values-opacity (bool = false) Whether to toggle the opacity of the colored values
- show-alt-tiers-in-table (bool = false) Whether to display alternative tiers in the main table
- show-alt-tier-in-empty-cells (bool = false) Whether to display the alternative tier if the cell is empty
- show-value-on-hover (bool = false) Whether to display the annotation value on mouse over
- show-snap-on-hover (bool = false) Whether to display the media snapshot on mouse over
- show-media-on-click (bool = false) Whether to display the media player on click
- video-player-width (string = 300)
- video-player-height (string)
Input
- Array<Annotation>
<VIEW type="density-timeline" zoom-factor="500">
...
</VIEW>
form
The form view renders HTML input forms, allowing easy online sharing for collecting external data. Form results are simple JSON files which can then be imported back as virtual tiers for further analysis.
- show-header (bool = false) Whether to display table header
- show-index (bool = true) Whether to display index column
- show-value (bool = true) Whether to display annotation's text value
- show-video (bool = true) Whether to display annotation's video clip
- show-tier (bool = true) Whether to display tier's name
- show-file (bool = false) Whether to display annotation file name
- cotext (int = 0) Number of cotext annotations to show before and after (0 = no cotext)
- cotext-range (number = 0) Max number of seconds to consider a neighbor annotation as a valid cotext annotation (0 = no limit)
- cotext-media (bool = false) Whether to extend the clip to include the cotext annotations (make sure to use a reasonable cotext-range to avoid super long clips)
- extend-duration (number = 0) Number of seconds to add before and after when cutting the clip
- label-save (string = SAVE) Save button label
- name (string) a name to identify this form, will be used as filename and accept field parameters interpolation
Input
- Array<Annotation>
intercoding
The intercoding view makes it easy to process JSON files resulting from forms, and display them in a meaningful way for intercoding validation and statistics.
- reference (tier) The tier used as reference, if any.
- show-video (bool = true) Whether to display the annotation's video clip
- show-index (bool = true) Whether to display the index
- values-replacement (js) A JSON object used to replace a given value with another one, like {"a1":"A", "a2":"A"}
- weight-matrix (bool = false) Whether to use the weight matrix
- weight-matrix-values (matrix) A custom matrix defining the weight of each values' pair
- weight-matrix-func (js) A custom JS function that should return the weight for a given pair provided as arguments, like (a,b) => a==b ? 1 : 0
- save-weight-matrix-csv (string) Name of a CSV file to export the weight matrix
- save-coincidence-matrix-csv (string) Name of a CSV file to export the coincidence matrix
- save-krippendorff-alpha-json (string) Name of a JSON file to export Krippendorff's alpha, as {"alpha":X}
Input
- Array<Annotation>
json
Displays JSON serializable data as an interactive tree
Input
- Object
- Array
<VIEW type="json">
...
</VIEW>
list
The list view simply renders annotations one after another. It is possible to specify a custom class for switching display to grid mode.
- show-value (bool = true) Whether to display annotation's text value
- show-media (bool = true) Whether to display annotation's media clip
- show-snap (bool = false) Whether to display annotation's snapshot
- show-tier (bool = true) Whether to display tier's name
- class (string = list) Alternative display style
- file-header (html) Raw html to insert as a header before each file
- file-separator (html) Raw html to insert as a separator between each file
- file-footer (html) Raw html to insert as a footer after each file
Input
- Array<Annotation>
<VIEW type="list" show-tier="false" style="grid">
...
</VIEW>
table
The table view can display various annotations' (or objects) properties into table columns. It also supports the Extra protocol allowing user-defined properties to be displayed as columns.
Input
- Array<Annotation>
- Array<Object>
<VIEW type="table">
<SET column="tier" name="Actor" />
<SET column="value" name="Transcript" />
<SET column="video" name="Video Clip" />
...
</VIEW>testcase
A special view to display testcase results
timeline
The timeline view displays annotations vertically with time markers, and using one column per tier. Ideal for dialogs between 2+ participants.
- collapse (int = 60) Max number of seconds between 2 annotations beyond which a separator indicating collapsed duration is displayed
- show-value (bool = true) Whether to display the annotation's text value
- show-video (bool = true) Whether to display the annotation's video clip
- show-timestamp (bool = true) Whether to display the timestamp
- group (bool = false) Whether to separate annotations based on their group instead of their file
- sequence (string) Separate annotations based on another tier's annotations (used as sequences)
Input
- Array<Annotation>
<VIEW type="timeline" collapse="60">
...
</VIEW>
wordcloud
The wordcloud helps visualize frequency of words and has many customisation attributes. Wordcloud can slow down PDF generation time and can take some time to show-up.
- length-threshold (int = 3) Exclude words with less than length-threshold letters
- frequency-threshold (int = 0) Exclude words with a lower frequency
- size-factor (int = 0) The size factor to draw words (0 = auto)
- min-size (int = 0) (0 to disable)
- weight-factor (number = 1)
- font-family (string)
- font-weight (string = normal)
- color (string = random-dark)
- background-color (string = #fff)
- draw-out-of-bound (bool = false)
- shrink-to-fit (bool = false)
- origin (array) origin of the “cloud” in [x, y]
- min-rotation (number = -Math.PI / 2)
- max-rotation (number = Math.PI / 2)
- rotation-steps (number = 0)
- rotate-ratio (number = 0.1)
- shape (string = circle)
- ellipticity (number = 0.65)
- shuffle (bool = true)
- list-words (int = 0) How many words to show in a table, 0 to disable
Input
- Array<Annotation>
- Array<Array> an array of ["word", weight] pairs
🗀 MIT LicenseWordcloud2 by Timothy Guan-tin Chien and contributorsgithub.com/timdream/wordcloud2.js
Charts
Use charts to visualize data through meaningful representations. Powered by D3.js and Observable
🗀 ISC LicenseD3 by Mike Bostockgithub.com/d3/d3
donut
- name (string = ([x]) => x) given d in data, returns the (ordinal) label
- value (string = ([, y]) => y) given d in data, returns the (quantitative) value
- title (string) given d in data, returns the title text
- width (string = 640) outer width, in pixels
- height (string = 400) outer height, in pixels
- innerRadius (string = 0) inner radius of pie, in pixels (non-zero for donut)
- outerRadius (string = Math.min(width, height) / 2) outer radius of pie, in pixels
- labelRadius (string = (innerRadius * 0.2 + outerRadius * 0.8)) center radius of labels
- format (string = ',') a format specifier for values (in the label)
- names (string) array of names (the domain of the color scale)
- colors (string) array of colors for names
- stroke (string = innerRadius > 0 ? 'none' : 'white') stroke separating widths
- strokeWidth (string = 1) width of stroke separating wedges
- strokeLinejoin (string = 'round') line join of stroke separating wedges
- padAngle (string = stroke === 'none' ? 1 / outerRadius : 0) angular separation between wedges
🗀 ISC LicenseAdapted fromobservablehq.com/@d3/donut-chart
grouped-bar
- x (string = (d, i) => i) given d in data, returns the (ordinal) x-value
- y (string = d => d) given d in data, returns the (quantitative) y-value
- z (string = () => 1) given d in data, returns the (categorical) z-value
- title (string) given d in data, returns the title text
- marginTop (string = 30) top margin, in pixels
- marginRight (string = 0) right margin, in pixels
- marginBottom (string = 30) bottom margin, in pixels
- marginLeft (string = 40) left margin, in pixels
- width (string = 640) outer width, in pixels
- height (string = 400) outer height, in pixels
- xDomain (string = d3.groupSort(data, g => d3.median(g, ${x}), ${x})) the x domain [xmin, xmax]
- xRange (string = [marginLeft, width - marginRight])
- xPadding (string = 0.1) amount of x-range to reserve to separate groups
- yType (string = d3.scaleLinear) type of y-scale
- yDomain (string)
- yRange (string = [height - marginBottom, marginTop])
- zDomain (string = d3.groupSort(data, g => -d3.median(g, ${y}), ${z})) the z domain
- zPadding (string = 0.05) amount of x-range to reserve to separate bars
- yFormat (string) a format specifier string for the y-axis
- yLabel (string) a label for the y-axis
- filterZ (string = false) other way
- separatorWidth (string = 0)
- separatorOffset (string = 0)
- separatorColor (string = 'gainsboro')
- colors (string) array of colors
🗀 ISC LicenseAdapted fromobservablehq.com/@d3/grouped-bar-chart
horizontal-bar
- x (string = d => d) given d in data, returns the (quantitative) x-value
- y (string = (d, i) => i) given d in data, returns the (ordinal) y-value
- title (string) given d in data, returns the title text
- marginTop (string = 30) the top margin, in pixels
- marginRight (string = 0) the right margin, in pixels
- marginBottom (string = 10) the bottom margin, in pixels
- marginLeft (string = 80) the left margin, in pixels
- width (string = 640) the outer width of the chart, in pixels
- height (string) outer height, in pixels
- xType (string = d3.scaleLinear) type of x-scale
- xDomain (string)
- xRange (string = [marginLeft, width - marginRight])
- xFormat (string) a format specifier string for the x-axis
- xLabel (string) a label for the x-axis
- yPadding (string = 0.1) amount of y-range to reserve to separate bars
- yDomain (string) an array of (ordinal) y-values
- yRange (string)
- colors (string) array of colors
- titleColor (string = "white") title fill color when atop bar
- titleAltColor (string = "currentColor") title fill color when atop background
🗀 ISC LicenseAdapted fromobservablehq.com/@d3/horizontal-bar-chart
inline
- x (string = ([x]) => x) given d in data, returns the (temporal) x-value
- y (string = ([, y]) => y) given d in data, returns the (quantitative) y-value
- z (string = () => 1) given d in data, returns the (categorical) z-value
- defined (string) for gaps in data
- curve (string = d3.curveLinear) method of interpolation between points
- marginTop (string = 30) top margin, in pixels
- marginRight (string = 50) right margin, in pixels
- marginBottom (string = 30) bottom margin, in pixels
- marginLeft (string = 30) left margin, in pixels
- width (string = 640) outer width, in pixels
- height (string = 400) outer height, in pixels
- xType (string = d3.scaleOrdinal) type of x-scale
- xDomain (string = d3.groupSort(data, g => d3.median(g, ${x}), ${x})) the x domain [xmin, xmax]
- xRange (string)
- yType (string = d3.scaleLinear) type of y-scale
- yDomain (string)
- yRange (string = [height - marginBottom, marginTop])
- zDomain (string) array of z-values
- yFormat (string) a format specifier string for the labels
- colors (string = d3.schemeCategory10) stroke color of line
- strokeLinecap (string = 'round') stroke line cap of the line
- strokeLinejoin (string = 'round') stroke line join of the line
- strokeWidth (string = 2) stroke width of line, in pixels
- strokeOpacity (string = 1) stroke opacity of line
- halo (string = '#fff') color of label halo
- haloWidth (string = 6) padding around the labels
🗀 ISC LicenseAdapted fromobservablehq.com/@d3/inline-labels
pie
- name (string = ([x]) => x) given d in data, returns the (ordinal) label
- value (string = ([, y]) => y) given d in data, returns the (quantitative) value
- title (string) given d in data, returns the title text
- width (string = 640) outer width, in pixels
- height (string = 400) outer height, in pixels
- innerRadius (string = 0) inner radius of pie, in pixels (non-zero for donut)
- outerRadius (string = Math.min(width, height) / 2) outer radius of pie, in pixels
- labelRadius (string = (innerRadius * 0.2 + outerRadius * 0.8)) center radius of labels
- format (string = ',') a format specifier for values (in the label)
- names (string) array of names (the domain of the color scale)
- colors (string) array of colors for names
- stroke (string = innerRadius > 0 ? 'none' : 'white') stroke separating widths
- strokeWidth (string = 1) width of stroke separating wedges
- strokeLinejoin (string = 'round') line join of stroke separating wedges
- padAngle (string = stroke === 'none' ? 1 / outerRadius : 0) angular separation between wedges
🗀 ISC LicenseAdapted fromobservablehq.com/@d3/pie-chart
Operations
An operation takes input data and transforms it. Operations can also modify or filter the current selection of annotations.
annotations-from-forms
Loads JSON files resulting from forms, as virtual annotations. This operation is deprecated and load-annotations-from-forms should be used instead.
Input
- None
Output
- Array<Annotation>
<OP annotations-from-form="my form (*).json" />
clone
Clones each annotation in the selection, so they can be modified without affecting the originals.
Input
- Array<Annotation>
Output
- Array<Annotation>
<OP clone="" />
count
Counts the elements in each array element of the input array/object, replacing the array element itself with an integer value
- depth (int = 0) How deep to go in the input tree before counting
- remove-uncountable (bool = false) Whether to remove the properties that are not countable
- remove-uncountable-elements (bool = false) Whether to remove the uncountable elements from array, resulting in a shorter array
- count-strings (bool = false) Whether to consider strings as arrays for counting
Input
- Array<Array>
- Object<Array>
Output
- Array<Integer>
- Object<Integer>
<OP count="" />
count-by
Counts by a specific property
Input
- Array<Annotation|Object>
- Object<String,Array<Annotation|Object>>
<OP count-by="tier" />
count-object-keys
Count keys across all input objects
Input
- Array<Object>
Output
- Object
detect-sequences
Detects sequences by grouping annotations that are close to each other.
- range (number = 30) Minimum number of seconds between two annotations to consider as a new sequence
- to-tier (string = sequences) The created tier wich will contain the sequences annotations
- output (choices = array) The output type, which can be an Array of sequences' annotations, or an Object
mapping a sequence to its list of annotations.
Input
- Array<Annotation>
Output
- Array<Annotation>
- Object<String,Array<Annotation>>
<OP detect-sequences="" _.range="15" _.output="object" />
duration-by
Calculate sum of annotations' duration by grouping on a property (value/tier/group/participant)
- factor (int = 1) Convert milliseconds to other units
- truncate (int = -1) Truncate factored value to X decimal places
Input
- Array<Annotation>
- Object<String,Array<Annotation>>
<OP duration-by="tier" _.factor="60000" _.truncate="2" />
each
Iterates over the array(s) values, and executes the provided function
Input
- Array
- Object<String,Array>
<OP each="o => o.x = (o.x * 42) + 7" />
each-file
Iterates over each file, and executes the provided function
Input
Output
<OP each-file="file => log.info(file.filename)" />
extend-duration
Takes each input annotation and extends its duration by changing their start and/or stop times. This will by default clone all input annotations so the originals stay unaffected.
- before (number) Seconds to add before start (default to arg)
- after (number) Seconds to add after stop (default to arg)
- clone (bool = true) Whether to clone the annotation before changing its duration
Input
- Array<Annotation>
Output
- Array<Annotation>
<OP extend-duration="2" />
filter
Filters the array(s) keeping only items passing the filter expression
Input
- Array
- Object<String,Array>
<OP filter="annotation => annotation.tier.id.contains('x')" />
filter-by-value
Filters the array(s) keeping only annotations whose value matches the provided regexp
Input
- Array<Annotation>
- Object<String,Array<Annotation>>
<OP filter-by-value="wh." />
flatten
Transforms nested objects into a flat array of objects
Input
- Object
Output
- Array<Object>
<OP flatten="{name,value}" />
<OP flatten="{group,name,value}" />
group-by
Groups the array elements by the value of a specific element's property. The result is an object whose keys are the property values, mapped to arrays of elements.
Input
- Array
Output
- Object<String,Array>
<OP group-by="tier" />
group-by-ref-value
load-annotations-from-forms
Loads JSON files resulting from forms, as virtual annotations. The JSON files must be in the folder of the processed XML file.
- dimension (string) The dimension to extract from the form
- exclude-from-intercoding (bool = false) Whether to tag the extracted annotations so they are excluded from intercoding calculations
- extract-original-annotations (bool = false) Whether to extract only the original annotations from the form, so the results are safe from corpus changes. When this attribute is specified, no dimension will be extracted: use again the operation to extract a dimension.
Input
- None
Output
- Array<Annotation>
<OP load-annotations-from-form="my form (*).json" />
load-data-from-json
Loads a JSON file or set data directly from embedded JSON. The JSON file must be in the folder of the processed XML file.
- json (js) json data
- file (string) file name
Input
- None
Output
- Object
- Array
<OP data-from-json="" _.file="myfile.json" />
<OP data-from-json="{foo:'bar', x:42}" />
<OP data-from-json="">{json5:"works"}</OP>
load-data-from-xls
Loads a XLS or CSV file.
- file (file) file name
Input
- None
Output
- Object
- Array
map
Creates a new array populated with the results of calling the provided function on each element of the input array(s). Special pseudo-object syntax can be used to facilitate direct mapping of object properties (see examples below).
Input
- Array
- Object<String,Array>
<OP map="annotation => { return {value: annotation.value, tier: annotation.tier.id} }" />
<OP map="{value: .value, tier: .tier.id}" />
<OP map="{value, tier: .tier.id}" />
mongo-clear
Clears a MongoDB Collection (drops the collection)
mongo-find
Loads objects from a MongoDB Collection
- query (js) The mongo query, a plain JS object like {property:"value"}
- projection (js) The query projection, a plain array like ['prop1','prop2'] listing the properties to return
- limit (int = 1000) The maximum number of documents to return
Output
- Array<Object>
mongo-insert
Inserts input objects into a MongoDB Collection
Input
- Array<Object>
- Object
mongo-remove
Removes objects from a MongoDB Collection
Input
- Array<Object>
- Object
percent-by
Calculates percentage of an annotations' property value occurrence.
Input
- Object<String,Array<Annotation>>
<OP percent-by="tier" />
randomize
Randomizes the input selection with a PRNG allowing reproducible results based on an initial seed.
- limit (int = 0) Maximum number of elements for the output array
- limit-per-file (0) Maximum number of annotations to take from one particular annotation file (if the input array contains annotations)
- seed (int = 1) The initial seed for reproducible randomness
- prng (string = LCG) The algorithm for random number generation
Input
- Array
Output
- Array
reduce
Executes a "reducer" function on each element of the input array(s), in order, passing in the return value from the calculation on the preceding element. The final result of running the reducer across all elements of the array is a single value. (accumulator, currentValue) => accumulator + currentValue, initialValue
Input
- Array
- Object<String,Array>
<OP reduce="(totalChars, annotation) => totalChars + annotation.value.length, 0" />
replace-with-annotations-in-sequence-from-tier
Considers each input annotation as a sequence, and selects those from another tier (of the same file) that are included in the sequences.
- overlap (bool = true) Whether to include overlaping annotations (not fully contained in the sequence)
- range (number = 0) Additional range in seconds to consider annotations in sequence
- combine (bool = false) Whether to combine in one final annotation, all the annotations found in the sequence
- separator (string = | ) A separator to insert when combining values of multiple annotations
- default-to-null (bool = false) Whether to add a null element in the output array if no corresponding annotation is found for a given input annotation (default to false, or true if the operation runs in an EXTRA block)
Input
- Array<Annotation>
Output
- Array<Annotation>
<OP replace-with-annotations-in-sequence-from-tier="tier id" _.overlap="false" />
replace-with-next-timecode-annotations-from-tier
Replaces each input annotation with one from another tier (of the same annotations' file), the first found whose start time is after input annotation's start time.
- range (int = 0) Maximum time range to find next annotation (0 = no maximum)
Input
- Array<Annotation>
Output
- Array<Annotation>
<OP replace-with-next-timecode-annotations-from-tier="tier id" _.range="60" />
replace-with-same-timecode-annotations-from-tier
Replaces each input annotation with one from another tier that has the same start time.
- multiple (bool = false) Whether to select multiple annotations if more than one is in range
- range (number = 0) Acceptable range in seconds to consider 2 timecodes as equivalent
- default-to-null (bool) Whether to add a null element in the output array if no corresponding annotation is found for a given input annotation (default to false, or true if the operation runs in an EXTRA block)
Input
- Array<Annotation>
Output
- Array<Annotation>
<OP replace-with-same-timecode-annotations-from-tier="tier id" _.range="0.5" />
sanitize-strip-xml-tags
Remove XML tags from annotations' value
Input
- Array<Annotation>
Output
- Array<Annotation>
<OP set-tag="+mytag" />
<OP set-tag="-mytag" />
save-data-to-csv
Saves current data to a CSV file. The file will be saved in the processed XML file's folder, overwriting any existing file.
Input
- Object
- Array
<OP save-data-to-csv="table.csv" />
save-data-to-json
Saves current data to a JSON file. The file will be saved in the processed XML file's folder, overwriting any existing file.
Input
- Object
- Array
<OP save-data-to-json="foobar.json" />
scrape
Loads an URL (or a file) and extract data
- url (string) URL to fetch for scraping
- file (file) a file path to load content instead of an URL
- jsoup (js) a function to extract data called with a Jsoup document as argument (to scrape HTML)
- js (js) a function to extract data called with the content as a string argument (to scrape JSON, text files...)
Input
Output
<OP scrape="" _.url="https://en.wikipedia.org/wiki/List_of_countries_by_GDP_(nominal)" />
selection-to-data
Transforms input annotations to an array of objects
- export-value (bool = true)
- export-value-as (string = value)
- export-tier (bool = true)
- export-tier-as (string = tier)
- export-start (bool = true)
- export-start-as (string = start)
- export-stop (bool = true)
- export-stop-as (string = stop)
Input
- Array<Annotation>
Output
- Array<Object>
set-global-variable
Sets a global variable which becomes available in HTML blocks as {{varname}}. Global variables can also be used in scripts with variables.varname
- value (js) a function called with current selection/data, which should return the value of the variable
set-tag
Adds or removes annotation's tag
Input
- Array<Annotation>
Output
- Array<Annotation>
<OP set-tag="+mytag" />
<OP set-tag="-mytag" />
set-tier
Changes the tier of each input annotation. By default will clone annotations so it does not affect original ones.
- clone (bool = true)
Input
- Array<Annotation>
Output
- Array<Annotation>
<OP set-tier="FAKE TIER" />
sort
Sorts input array by a given field
- natural (bool = false) Whether to sort based only on the digits contained in the field, and not string comparison
Input
- Array
Output
- Array
<OP sort="-start" />
sort-by-file
Sorts annotations first by their file, and then by the provided field or compare function. When providing a field, first character must indicate sorting order with +/- (ascending/descending)
- order (string) (+) (ascending/descending) Sorting order of the AF groups
- field (string) A field to sort on, like "+start"
Input
- Array<Annotation>
Output
- Array<Annotation>
<OP sort-by-file="" />
<OP sort-by-file="+start" />
<OP sort-by-file="-start" />
<OP sort-by-file="(a1,a2) => a1.start > a2.start ? -1 : 1" />
sort-by-group
Sorts annotations by their group, and then inside each group by their relative start time (using eventual file time-offset) If no field is provided, sorting will be done around //TODO
- order (string) (+) Sorting order of groups (ascending/descending)
- natural (bool = false) Natural integer sorting instead of string
- field (string) A field to sort on, like "+start"
Input
- Array<Annotation>
Output
- Array<Annotation>
<OP sort-by-group="" />
sum-by
Calculate sum of the annotations' property value. (not working yet)
Input
- Object<String,Array<Annotation>>
<OP percent-by="tier" />
type-token
Computes the type-token of input annotations.
- group-by-attribute (string) An optional attribute name to be used for grouping type-tokens together
- strip-punctuation (bool = true) Whether to remove all punctuation before type-token processing
- case-sensitive (bool = false) Whether to consider capital letters in words comparison
- replace-regex (string) A regular expression to replace text before type-token processing
- replace-func (string) A js function to replace text before type-token processing
- split-func (string) A js function to use instead of the basic space splitting, for extracting words from strings
Input
- Array<Annotation>
- Object<Array<Annotation>>
- Object<Array<String>>
- Object<String>
Output
- Object
Processors
Use processors to analyze or convert raw data such as audio or video, and to manipulate the corpus.
audio-anonymizer
Audio Anonymizer modifies media files by applying audio filters on each input annotation segment. Available modes are - silence: replaces each segment with complete silence (default) - noise: replaces each segment with a configurable noise - beep: replaces each segment with a configurable beep - voice: replaces each segment with a synthetized voice - file: replaces each segment with a custom audio file
- mode (string = silence) The mode of anonymization, an audio transformation that will be applied to each annotation segment.
- mute (bool = true) Whether to silence the segment anyway before mixing the noise/beep/voice/file
- beep-frequency (int = 800) The frequency to use for sine beep sound
- noise-amplitude (number = 1) Amplitude of the generated noise
- noise-color (string = white) Noise color
- noise-seed (int) Seed value for noise PRNG
- noise-weight (number = 1) Mixing weight of the noise sound
- voice-text (string) Text to synthetize and use for anonymization. If not provided, the annotation's value will be used.
- voice-amplitude (int = 100) How loud the voice will be.
- voice-pitch (int = 50) The voice pitch
- voice-speed (int = 175) The speed at which to talk (words per minute)
- voice-wordgap (int = 0) Additional gap between words in 10 ms units
- file (string) Path to an audio file to use for anonymization, when mode is set to "file"
Input
- Array<Annotation>
🗀 GPL-3.0 LicenseSpeech Synthesizergithub.com/kripken/speak.js
🗀 GNU GPL LicenseOriginal eSpeak library ported by speak.js
demucs-separation
Demucs can separate voice and instruments from an audio track
- source (string = vocals) The source type to separate from the rest
⭳ MIT LicenseHybrid Spectrogram and Waveform Source Separationgithub.com/facebookresearch/demucs
export-corpus-media
Copy current corpus media files to a folder. The folder will be created in AVAA's temp directory.
- folder (string = exported-corpus) Name of the folder to create and populate with the corpus media files
- overwrite (bool = false) Whether to overwrite existing files in the folder, otherwise another folder will be created
- copy-temp (bool = false) Whether to copy the files even if they come from the temp folder, otherwise temporary files are just moved to destination folder
export-to-eaf 🧪
Exports current corpus to EAF format.
- copy-media (bool = false) Whether to copy the associated media files next to EAF file, to use as relative path (good for sharing). Otherwise absolute path of media will be used (good for testing)
- export-empty-tiers (bool = false) Whether to also exports the tiers that don't have any annotation
export-to-srt 🧪
Exports a selection of annotations to SRT format
- copy-media (bool = false) Whether to copy the associated media files next to SRT file
Input
- Array<Annotation>
ffmpeg-cut
Cuts a segment from each corpus media file. This processor also accepts an array of annotations to cut multiple segments. In this case, the corpus will be reduced to relevant annotation files and each media file will be replaced by its cuts, or by a one merged file from all cuts when "concat" attribute is set to true.
- start (string) Starting point in seconds to start cutting from
- duration (string) Duration of cut segment
- concat (bool = false) Whether to concat all segments in case multiple are cut
Input
- Array<Annotation>
ffmpeg-denoise 🧪
This processor calls ffmpeg's denoise feature. - FFT: Denoises audio with FFT. - NLM: Reduces broadband noise using a Non-Local Means algorithm. - RNN: Reduces noise from speech using Recurrent Neural Networks model. Learn more about the RNN models at https://github.com/GregorR/rnnoise-models
- method (string) The denoise method to use
- rnn-model (string)
- rnn-mix (number = 1) How much to mix filtered samples into final output. Allowed range is from -1 to 1. Default value is 1. Negative values are special, they set how much to keep filtered noise in the final filter output
🗀 No LicenseNoise Removal Neural Network Modelsgithub.com/GregorR/rnnoise-models
ffmpeg-filter-audio
This processor calls ffmpeg with a user defined audio filter Learn more about what filters can do at https://www.ffmpeg.org/ffmpeg-filters.html
- filter-audio (string) The filter expression
- sample-rate (string) If specified, audio output will also be resampled
ffmpeg-filter-complex
This processor calls ffmpeg with a user defined filter-complex. Learn more about what filters can do at https://www.ffmpeg.org/ffmpeg-filters.html
- filter-complex (string) The filter expression
ffmpeg-frei0r 🧪
Applies a frei0r filter on each corpus media file.
- filter (string) The frei0r filter to use
- param-1 (string) A parameter to pass to the filter
- param-2 (string) A parameter to pass to the filter
- param-3 (string) A parameter to pass to the filter
🗀 GPL-2.0 LicenseVideo filters bygithub.com/dyne/frei0r
🗀 CC BY-NC-ND 4.0 LicenseFrei0r DLL pack for Windows by Gyan Doshiwww.gyan.dev/ffmpeg
hardsub
Hardcodes annotations as subtitles on top of video. This processor will automatically use the values of the annotations that generated the clips, whenever they are available. It is possible to use different annotations from other tiers in range, by adding "source-tier" parameters.
- include-tier-names (bool = false) Whether to include the tier names in the subtitles
- include-tier-separator (string = : ) A separator to add between tier name and subtitle text
- extend-duration-before (int = 0) Number of milliseconds to display subtitle before its original start time, so it is shown earlier
- extend-duration-after (int = 0) Number of milliseconds added after the original end time, so it stays visible longer
- style-color (color = #FFFFFF) Subtitles color
- style-opacity (string = 100%) Subtitles opacity, in %
- style-outline-color (color = #000000) Subtitles text outline color
- style-outline-opacity (string = 100%) Opacity of text outline, in %
- style-outline-width (string) Width of the text outline, in pixels
- style-size (int) Subtitles size
- style-bold (bool = false) Subtitles weight
- style-font (string) Subtitles font name
media-converter 🧪
Use Media Converter to convert video and audio files into other formats
- video-resolution (string) Resolution of converted video (like 1280x720)
- audio-volume (number = 1) Audio volume
Input
- Array<Annotation>
r-script 🧪
This processor calls R with user provided data, and integrates the resulting data into the final HTML page. Resulting R output can be graphic files (jpg, png, gif, svg) or tabular text data. Input provided to R as arguments are in order: - temp directory path to work with and create result files - path to a JSON file consisting of the selection (annotations) or data provided to the processor R scripts must follow a specific input/output syntax to be compatible with AVAA (see "Calling R" in the scripting guide).
- file (file) .R file to run
- source (script) Plain R source code to run
reduce-corpus
Reduce the corpus to specific files. Useful to work on a subset of the corpus without modifying the corpus itself. This processor also accepts a selection of annotations, in which case only corpus files of these annotations will be kept.
- group (regexp) Which group of corpus files to keep (regular expression)
- file (regexp) Which file from the corpus to keep (regular expression)
- tag (regexp) Files from the corpus to keep that have a tag satisfying this regular expression
- filter (js) A custom filter function called for each file that should return true to keep the file, like (f)=>f.filename.includes('.eaf')
Input
- Array<Annotation>
remove-sequences-from-corpus
Takes a selection of annotations and modifies the corpus, using the input annotations as sequences, each sequence being removed from the corpus file, with its associated media segment and all the annotations included in that sequence.
Input
- Array<Annotation>
rename-tiers
Rename tiers in all the corpus files.
- from (string) The tier name to be replaced
- to (string) The replacement name to use
- map (js) A JSON object mapping the names to replace (keys) to the new names (values), like {"OLD NAME":"NEW NAME"}
sequences-to-corpus
Takes a selection of annotations and recreates the corpus, using the input annotations as sequences, each sequence being transformed into one corpus file with its associated media file and all the annotations/tiers included in that sequence.
- name-template (js = `sequence-${i}-${a.af.id}`) The template function to build the name of each corpus file, provided with the annotation and its index, like (a,i) => `${i} - ${a.value}`
Input
- Array<Annotation>
speaker-diarization-pyannote
Speaker diarization is the process of marking segments of voice with their speaker. This processor takes a selection of annotations, and add to the corpus new annotations associated with their speaker tier.
- hf-token (string) The HuggingFace access token, required to download pyannote models
- speakers (int = 0) Number of speakers in the audio
Input
- Array<Annotation>
Output
- Array<Annotation>
⭳ MIT LicenseSpeaker diarizationgithub.com/pyannote/pyannote-audio
speech-to-text-whisper
A speech to text processor using OpenAI Whisper to transcribe and automatically create annotations
- language (string) The language to transcribe, if not specified autodetect will be attempted
- model (string = small) The trained model to use for transcription
- temperature (number = 0) Temperature, adjust to fix hallucinations
- output-tier (string = stt-whisper) Tier id for the extracted annotations
- verbose (bool = false) Whether to log the transcriptions as soon as they are detected
Output
- Array<Annotation>
⭳ MIT LicenseRobust Speech Recognition via Large-Scale Weak Supervisiongithub.com/openai/whisper
vad-silero
Silero's Voice Activity Detector processor creates annotations for each segment of input audio containing voice.
- output-tier (string = vad-silero) Tier id for the generated annotations
- threshold (number = 0.5) Use a higher threshold for noisy audio
- sampling-rate (number = 16000)
- min-silence-duration (int = 500) Number of milliseconds
- min-speech-duration (int = 1000) Minimum duration (in milliseconds) of activity to consider a voice segment
Output
- Array<Annotation>
⭳ MIT LicensePre-trained enterprise-grade Voice Activity Detectorgithub.com/snakers4/silero-vad
🗀 MIT LicenseSilero JIT and ONNX files
video-anonymizer 🧪
Anonymize videos with these special effects: - deface: automatically detects and blur faces - cartoon: cartoonize the video - cartoon-blur: cartoonize and blur the video
- mode (string) The type of anonymisation to apply on the video
- deface-mode (string = blur) Anonymization filter mode for face regions
- deface-threshold (number = 0.2) Detection threshold (tune this to trade off between false positive and false negative rate)
- deface-mask-scale (number = 1.3) Scale factor for face masks, to make sure that masks cover the complete face
- deface-mosaicsize (int = 20) Width of the mosaic squares when deface-mode is mosaic
- deface-boxes (bool = false) Use boxes instead of ellipse masks
- deface-draw-scores (bool = false) Draw detection scores onto outputs, useful to find the best threshold
- deface-downscale (string) Downscale resolution for the network inference (WxH)
⭳ MIT LicenseVideo anonymization by face detectiongithub.com/ORB-HD/deface
🗀 GPL-2.0 LicenseVideo filters bygithub.com/dyne/frei0r
🗀 CC BY-NC-ND 4.0 LicenseFrei0r DLL pack for Windows by Gyan Doshiwww.gyan.dev/ffmpeg