sox_convert.html

<!--
  Copyright 2020, Johannes Kropf
  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('sox-convert',{
        category: 'Sox Utils',
        color: '#c28285',
        defaults: {
            name: {value:""},
            conversionType: {value:"wav", required:true},
            outputToFile: {value:"buffer", required:true},
            manualPath: {value:""},
            wavMore: {value:false, required:true},
            wavByteOrder: {value:"-L", required:true},
            wavEncoding: {value:"signed-integer", required:true},
            wavChannels: {value:1, required:true},
            wavRate: {value:16000, required:true},
            wavBits: {value:16, required:true},
            flacMore: {value:false, required:true},
            flacCompression: {value:8, required:true},
            flacChannels: {value:1, required:true},
            flacRate: {value:16000, required:true},
            flacBits: {value:16, required:true},
            mp3More: {value:false, required:true},
            mp3Channels: {value:2, required:true},
            mp3Rate: {value:44100, required:true},
            mp3BitRate: {value:128, required:true},
            oggMore: {value:false, required:true},
            oggCompression: {value:3, required:true},
            oggChannels: {value:2, required:true},
            oggRate: {value:44100, required:true},
            debugOutput: {value:false, required:true}
        },
        inputs:1,
        outputs:2,
        icon: "font-awesome/fa-arrow-right",
        inputLabels: function(index) {
            return 'input audio to convert';
        },
        outputLabels: function(index) {
            if (index === 0) {
                return "converted audio"
            } else {
                return 'conversion debug';
            }
        },
        label: function() {
            return this.name||"sox-convert";
        },
        oneditprepare: function() {
            var node = this;
            
            $("#node-input-conversionType").on("change", function(){
                let typeVar = $("#node-input-conversionType").val();
                if(typeVar == "wav"){
                    $("#outputExt").text(".wav");
                    $("#wavWrapper").show();
                    $("#mp3Wrapper").hide();
                    $("#flacWrapper").hide();
                    $("#oggWrapper").hide();
                } else if (typeVar == "flac") {
                    $("#outputExt").text(".flac");
                    $("#flacWrapper").show();
                    $("#wavWrapper").hide();
                    $("#mp3Wrapper").hide();
                    $("#oggWrapper").hide();
                } else if (typeVar == "mp3") {
                    $("#outputExt").text(".mp3");
                    $("#mp3Wrapper").show();
                    $("#wavWrapper").hide();
                    $("#flacWrapper").hide();
                    $("#oggWrapper").hide();
                } else if (typeVar == "ogg") {
                    $("#outputExt").text(".ogg");
                    $("#oggWrapper").show();
                    $("#wavWrapper").hide();
                    $("#flacWrapper").hide();
                    $("#mp3Wrapper").hide();
                }
            });
            
            $("#node-input-outputToFile").on("change", function(){
                let output = $("#node-input-outputToFile").val();
                if(output == "buffer"){
                    $("#outputPathWrapper").hide();
                } else {
                    $("#outputPathWrapper").show();
                }
            });
            
            $("#node-input-wavMore").on("change", function(){
                if(!$("#node-input-wavMore").prop("checked")){
                    $("#wavWrapperMore").hide();
                } else {
                    $("#wavWrapperMore").show();
                }
            });
            
            $("#node-input-mp3More").on("change", function(){
                if(!$("#node-input-mp3More").prop("checked")){
                    $("#mp3WrapperMore").hide();
                } else {
                    $("#mp3WrapperMore").show();
                }
            });
            
            $("#node-input-flacMore").on("change", function(){
                if(!$("#node-input-flacMore").prop("checked")){
                    $("#flacWrapperMore").hide();
                } else {
                    $("#flacWrapperMore").show();
                }
            });
            
            $("#node-input-oggMore").on("change", function(){
                if(!$("#node-input-oggMore").prop("checked")){
                    $("#oggWrapperMore").hide();
                } else {
                    $("#oggWrapperMore").show();
                }
            });
        }
    });
</script>

<script type="text/html" data-template-name="sox-convert">
    <div class="form-row">
        <label for="node-input-conversionType"></i>convert to</label>
        <select id="node-input-conversionType">
            <option value="wav">wav</option>
            <option value="flac">flac</option> 
            <option value="mp3">mp3</option>
            <option value="ogg">ogg</option>
        </select>
    </div>
    <div class="form-row">
        <label for="node-input-outputToFile"></i>output as</label>
        <select id="node-input-outputToFile">
            <option value="buffer">a single buffer in the msg.payload</option>
            <option value="file">a file on the local file system</option> 
        </select>
    </div>
    <div id="outputPathWrapper" class="form-row" style="display:inline;">
        <label for="node-input-manualPath"><i class="icon-tag"></i>output File</label>
        <input type="text" id="node-input-manualPath" placeholder="" style="display:inline-block; width: 60%; vertical-align:baseline;">
        <label for="node-input-manualPath" id="outputExt" style="width: 10%;">.wav</label>
    </div>
    <h4>Settings</h4>
    <div id="wavWrapper">
        <div class="form-row">
            <label for="node-input-wavMore">advanced</i></label>
            <input type="checkbox" id="node-input-wavMore" style="display:inline-block; width: auto; vertical-align:baseline;" value="false">
            <label for="node-input-wavMore" style="width: 70%;">show more conversion options</label>
        </div>
        <div id="wavWrapperMore">
            <div class="form-row">
                <label for="node-input-wavByteOrder"></i>byte order</label>
                <select id="node-input-wavByteOrder">
                    <option value="-L">little endian</option> 
                    <option value="-B">big endian</option>
                </select>
            </div>
            <div class="form-row">
                <label for="node-input-wavEncoding"></i>encoding</label>
                <select id="node-input-wavEncoding">
                    <option value="signed-integer">signed-integer</option> 
                    <option value="unsigned-integer">unsigned-integer</option>
                    <option value="floating-point">floating-point</option>
                </select>
            </div>
            <div class="form-row">
                <label for="node-input-wavChannels"><i class="icon-tag"></i>channels</label>
                <input type="number" id="node-input-wavChannels" value="1" />
            </div>
            <div class="form-row">
                <label for="node-input-wavRate"><i class="icon-tag"></i>sample-rate</label>
                <input type="number" id="node-input-wavRate" value="16000" />
            </div>
            <div class="form-row">
                <label for="node-input-wavBits"><i class="icon-tag"></i>bit-depth</label>
                <input type="number" id="node-input-wavBits" value="16" />
            </div>
            <br>
        </div> 
    </div>
    <div id="flacWrapper">
        <div class="form-row">
            <label for="node-input-flacCompression"><i class="icon-tag"></i>compression</label>
            <input type="number" id="node-input-flacCompression" value="8" />
        </div>
        <p>Compression is given as a whole number from from 0 (fastest / lowest compression) to 8 (slowest / most compression).</p>
        <br>
        <div class="form-row">
            <label for="node-input-flacMore">advanced</i></label>
            <input type="checkbox" id="node-input-flacMore" style="display:inline-block; width: auto; vertical-align:baseline;" value="false">
            <label for="node-input-flacMore" style="width: 70%;">show more conversion options</label>
        </div>
        <div id="flacWrapperMore">
            <div class="form-row">
                <label for="node-input-flacChannels"><i class="icon-tag"></i>channels</label>
                <input type="number" id="node-input-flacChannels" value="1" />
            </div>
            <div class="form-row">
                <label for="node-input-flacRate"><i class="icon-tag"></i>sample-rate</label>
                <input type="number" id="node-input-flacRate" value="16000" />
            </div>
            <div class="form-row">
                <label for="node-input-flacBits"><i class="icon-tag"></i>bit-depth</label>
                <input type="number" id="node-input-flacBits" value="16" />
            </div>
            <br>
        </div> 
    </div>  
    <div id="mp3Wrapper">
        <div class="form-row">
            <label for="node-input-mp3BitRate"><i class="icon-tag"></i>bit-rate kbps</label>
            <input type="number" id="node-input-mp3BitRate" value="128" />
        </div>
        <p>Mp3 conversion is only possible if you have an mp3 handler for sox installed.</p>
        <br>
        <div class="form-row">
            <label for="node-input-mp3More">advanced</i></label>
            <input type="checkbox" id="node-input-mp3More" style="display:inline-block; width: auto; vertical-align:baseline;" value="false">
            <label for="node-input-mp3More" style="width: 70%;">show more conversion options</label>
        </div>
        <div id="mp3WrapperMore">
            <div class="form-row">
                <label for="node-input-mp3Channels"><i class="icon-tag"></i>channels</label>
                <input type="number" id="node-input-mp3Channels" value="2" />
            </div>
            <div class="form-row">
                <label for="node-input-mp3Rate"><i class="icon-tag"></i>sample-rate</label>
                <input type="number" id="node-input-mp3Rate" value="44100" />
            </div>
            <br>
        </div>
    </div>
    <div id="oggWrapper">
        <div class="form-row">
            <label for="node-input-oggCompression"><i class="icon-tag"></i>compression / quality</label>
            <input type="number" id="node-input-oggCompression" value="3" />
        </div>
        <p>Compression / Quality is given as a number from from -1 (highest compression / lowest quality) to 8 (lowest compression / highest quality). Decimal values are allowed.</p>
        <br>
        <div class="form-row">
            <label for="node-input-oggMore">advanced</i></label>
            <input type="checkbox" id="node-input-oggMore" style="display:inline-block; width: auto; vertical-align:baseline;" value="false">
            <label for="node-input-oggMore" style="width: 70%;">show more conversion options</label>
        </div>
        <div id="oggWrapperMore">
            <div class="form-row">
                <label for="node-input-oggChannels"><i class="icon-tag"></i>channels</label>
                <input type="number" id="node-input-mp3Channels" value="2" />
            </div>
            <div class="form-row">
                <label for="node-input-oggRate"><i class="icon-tag"></i>sample-rate</label>
                <input type="number" id="node-input-mp3Rate" value="44100" />
            </div>
            <br>
        </div>
    </div>
    <div class="form-row">
        <label for="node-input-debugOutput"></i>debug</label>
        <input type="checkbox" id="node-input-debugOutput" style="display:inline-block; width: auto; vertical-align:baseline;" value="false">
        <label for="node-input-debugOutput" style="width: 70%;">detailed debug and conversion info</label>
    </div>
    <h4>Name</h4>
    <div class="form-row">
        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
        <input type="text" id="node-input-name" placeholder="Name">
    </div>	
</script>

<script type="text/html" data-help-name="sox-convert">
    <p><strong>A simple wrapper node around the conversion functionality of the sox commandline
    utility.</strong><br/></p>
    <p>This node will convert audio send to its input in the <code>msg.payload</code> either as a single
    buffer or as a path to a file to the selected format.
    It will output the converted audio as a buffer to the first output as a
    <code>msg.payload</code> or as a file on the file system. If configured to output to a file it
    will emit the file path of the converted audio to the first output when conversion is finished.
    Any recording information or debug info will be send in the <code>msg.payload</code>
    to its second output. The node tries to guess
    the audio format of buffer inputs for aiff, wav, flac, mp3 and ogg. For other formats you have to
    include the file extension as <code>msg.format</code> with the buffer input. If the input is raw
    audio you always for both files and buffers also need to include the sample rate as
    <code>msg.rate</code>, the encoding as
    <code>msg.encoding</code>, the bits per sample as <code>msg.bits</code> and the channels of the audio
    as <code>msg.channels</code>.<br/></p>
    <p><i>For detailed usage information please go to
    <a href="https://github.com/johanneskropf/node-red-contrib-sox-utils">node-red-contrib-sox-utils
    </a>.</i></p>
</script>