node-red-contrib-dynamorse-file-io
Version:
Dynamorse File IO nodes for Node-RED
211 lines (194 loc) • 10.1 kB
HTML
<!--
Copyright 2018 Streampunk Media Ltd.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<script type="text/javascript">
RED.nodes.registerType('mxf-in',{
category: 'funnel',
color: '#D79748',
defaults: {
name : { value : ''},
mxfUrl : { value : '', required : true },
loop : { value : false },
regenerate : { value : false },
description : { value : '' },
maxBuffer : { value : 10, validate : RED.validators.number() },
pictureTrack0 : { value : true },
pictureTrack1 : {value : false },
soundTrack0 : { value : true },
soundTrack1 : { value : false },
soundTrack2 : { value : false },
soundTrack3 : { value : false },
soundTrack4 : { value : false },
soundTrack5 : { value : false },
soundTrack6 : { value : false },
soundTrack7 : { value : false },
soundTrack8 : { value : false },
soundTrack9 : { value : false },
soundTrack10 : { value : false },
soundTrack11 : { value : false },
soundTrack12 : { value : false },
soundTrack13 : { value : false },
soundTrack14 : { value : false },
soundTrack15 : { value : false },
dataTrack0 : { value : false },
dataTrack1 : { value : false },
dataTrack2 : { value : false },
dataTrack3 : { value : false }
},
inputs:0,
outputs:1,
icon: "funnel.png",
label: function() {
return this.name || "mxf-in";
}
});
</script>
<script type="text/x-red" data-template-name="mxf-in">
<!-- Common to all funnel nodes -->
<div class="form-row">
<label for="node-input-name"><i class="fa fa-tag"></i> name</label>
<input type="text" id="node-input-name" placeholder="name">
</div>
<div class="form-row">
<label for="node-input-mxfUrl"><i class="fa fa-file"></i> MXF URL</label>
<input type="text" id="node-input-mxfUrl" placeholder="file:dynamorse.mxf">
</div>
<div class="form-row">
<label for="node-input-loop"><i class="fa fa-repeat"></i> loop?</label>
<input type="checkbox" id="node-input-loop" style="width: 100px">
<label for="node-input-regenerate"><i class="fa fa-clock-o"></i> regenerate?</label>
<input type="checkbox" id="node-input-regenerate" style="width: 100px">
</div>
<div class="form-row">
<label for="node-input-description"><i class="fa fa-info-circle"></i> description</label>
<input type="text" id="node-input-description" placeholder="source and flow description">
</div>
<div class="form-row">
<label for="node-input-maxBuffer"><i class="fa fa-suitcase"></i> max buffer</label>
<input type="number" id="node-input-maxBuffer" placeholder="10" style="width: 100px">
</div>
<div class="form-row">
<label><i class="fa fa-video-camera"></i> picture tracks</label>
<label style="width: 2em; text-align: right">0 </label><input type="checkbox" id="node-input-pictureTrack0" style="width: 1em"/>
<label style="width: 2em; text-align: right">1 </label><input type="checkbox" id="node-input-pcitureTrack1" style="width: 1em"/>
</div>
<div class="form-row">
<label><i class="fa fa-music"></i> sound tracks</label>
<label style="width: 2em; text-align: right">0 </label><input type="checkbox" id="node-input-soundTrack0" style="width: 1em"/>
<label style="width: 2em; text-align: right">1 </label><input type="checkbox" id="node-input-soundTrack1" style="width: 1em"/>
<label style="width: 2em; text-align: right">2 </label><input type="checkbox" id="node-input-soundTrack2" style="width: 1em"/>
<label style="width: 2em; text-align: right">3 </label><input type="checkbox" id="node-input-soundTrack3" style="width: 1em"/>
<label style="width: 2em; text-align: right">4 </label><input type="checkbox" id="node-input-soundTrack4" style="width: 1em"/>
<label style="width: 2em; text-align: right">5 </label><input type="checkbox" id="node-input-soundTrack5" style="width: 1em"/>
<label style="width: 2em; text-align: right">6 </label><input type="checkbox" id="node-input-soundTrack6" style="width: 1em"/>
<label style="width: 2em; text-align: right">7 </label><input type="checkbox" id="node-input-soundTrack7" style="width: 1em"/>
<br/><label> </label>
<label style="width: 2em; text-align: right">8 </label><input type="checkbox" id="node-input-soundTrack8" style="width: 1em"/>
<label style="width: 2em; text-align: right">9 </label><input type="checkbox" id="node-input-soundTrack9" style="width: 1em"/>
<label style="width: 2em; text-align: right">10 </label><input type="checkbox" id="node-input-soundTrack10" style="width: 1em"/>
<label style="width: 2em; text-align: right">11 </label><input type="checkbox" id="node-input-soundTrack11" style="width: 1em"/>
<label style="width: 2em; text-align: right">12 </label><input type="checkbox" id="node-input-soundTrack12" style="width: 1em"/>
<label style="width: 2em; text-align: right">13 </label><input type="checkbox" id="node-input-soundTrack13" style="width: 1em"/>
<label style="width: 2em; text-align: right">14 </label><input type="checkbox" id="node-input-soundTrack14" style="width: 1em"/>
<label style="width: 2em; text-align: right">15 </label><input type="checkbox" id="node-input-soundTrack15" style="width: 1em"/>
</div>
<div class="form-row">
<label><i class="fa fa-table" aria-hidden="true"></i> data tracks</label>
<label style="width: 2em; text-align: right">0 </label><input type="checkbox" id="node-input-dataTrack0" style="width: 1em"/>
<label style="width: 2em; text-align: right">1 </label><input type="checkbox" id="node-input-dataTrack1" style="width: 1em"/>
<label style="width: 2em; text-align: right">2 </label><input type="checkbox" id="node-input-dataTrack2" style="width: 1em"/>
<label style="width: 2em; text-align: right">3 </label><input type="checkbox" id="node-input-dataTrack3" style="width: 1em"/>
</div>
</script>
<style>
.param-table table, th, td {
vertical-align: top;
padding: 3px;
}
</style>
<script type="text/x-red" data-help-name="mxf-in">
<h1>MXF file input</h1>
<p>Read grains from a MXF stream, creating one or more NMOS flow(s) per
essence element. The MXF file may be located as a local file, on am HTTP
web-server or a FTP server, in which case specify
its location with a URL. If no protocol is specified, a file is
assumed to be stored locally.</p>
<p>Select the tracks from the that you would like to appear as NMOS flows.
Interleaved MXF files (MXF OP1a) may contain an interleaved mix of picture, sound
and data tracks. Mono-essence files (AS-02, IMF) contain only a single type of
essence. Selecting an essence track that does not exist will create a flow
record but no grains will flow. To find out what tracks an MXF file contains,
use an MXF dumping tool, such as <a href="https://github.com/Streampunk/kelvinadon">
kelvinadump</a>.</p>
<p>MXF nodes have three outputs. From top to bottom, these are:</p>
<ol>
<li>Picture (video) flows.</li>
<li>Sound (audio) flows.</li>
<li>Data (event) flows.</li>
</ol>
<h3>Parameters</h3>
<div class="param-table">
<table>
<tr>
<th>parameter</th><th>description</th>
</tr>
<tr>
<td><i class="fa fa-tag" aria-hidden="true"></i> name</td>
<td>Name of the node. Also used as a base for source & flow labels.</td>
</tr>
<tr>
<td><i class="fa fa-file"></i> MXF URL</td>
<td>Location of the MXF stream.</td>
</tr>
<tr>
<td><i class="fa fa-repeat"></i> loop?</td>
<td>Should the PCAP file be repeated indefinitely?</td>
</tr>
<tr>
<td><i class="fa fa-clock-o"></i> regenerate?</td>
<td>Should the grain metadata be regenerated locally?</td>
</tr>
<tr>
<td><i class="fa fa-info-circle"></i> description</td>
<td>Optional description of the this NMOS source and output flow.</td>
</tr>
<tr>
<td><i class="fa fa-suitcase"></i> max buffer</td>
<td>Maximum number of grains to buffer before overflowing.</td>
</tr>
<tr>
<td><i class="fa fa-video-camera"></i> picture tracks</td>
<td>Select the picture essence tracks to be used to create video flows.</td>
</tr>
<tr>
<td><i class="fa fa-music"></i> sound tracks</td>
<td>Select the sound essence tracks to be used to create audio flows.</td>
</tr>
<tr>
<td><i class="fa fa-table" aria-hidden="true"></i> data tracks</td>
<td>Select the data essence tracks to be used to create data flows.</td>
</tr>
</table>
</div>
<p>File path locations are relative to the folder where the dynamorse server was
started.</p>
<p>Source and flow labels and descriptions are created to included the MXF track
name, e.g. for a name <em>rise and shine</em>, the flow and source are labelled
and described as <code>rise and shine picture0</code>.</p>
<p>The phrase <em>essence track</em> refers to the pacakaging of essence elements
into groups of tracks. A sound essence track may have more than one channel and
each channel may be exposed as a seperate timeline track for the purpose of
presentation and editing.</p>
<h3>Maturity</h3>
<p>Work in progress -
<a href="https://github.com/Streampunk/dynamorse/issues/9">status</a>.
</script>