Experimental:Audio File Out CHOP

Summary

The Audio File Out CHOP saves an audio stream out to a file using a variety of different codecs.

Currently supports .wav, .mp3, .aiff, and .ogg container formats.

See also: Movie File Out TOP.

audiofileoutCHOP_Class

Parameters - Audio File Out Page

File Type filetype - ⊞ - Select the file type (container) of the output file.

• WAV wav - .wav file type. The audio codec can be chosen using the Codec parameter.

• OGG ogg - .ogg file type. The audio codec is Vorbis. Vorbis compression will have gapless playback.

• MP3 mp3 - .mp3 file type. The audio codec is MP3. MP3 compression will not have gapless playback. Vorbis (.ogg) is a good alternative for this.

• AIFF aiff - .aiff file type. The audio codec is Uncompressed 16-bit (PCM).

Unique Suffix uniquesuff - When enabled, me.fileSuffix will be a unique suffix when used in the file parameter.

N n - When unique suffix is disabled, me.fileSuffix will simply contain the value of N, instead of being unique

File file - Sets the path and filename of the audio file that is saved out. The file extension must match the file type parameter.

Codec codec - ⊞ - Select the compression codec when outputting WAV or AIFF file types. When using AIFF, Big Endian options are available, these are the industry standard when working with AIFF files.

• Uncompressed 16-bit (PCM) pcm16 - Uncompressed audio (Pulse Code Modulation)

• Uncompressed 24-bit (PCM) pcm24 - Uncompressed audio (Pulse Code Modulation)

• Uncompressed 32-bit (PCM) pcm32 - Uncompressed audio (Pulse Code Modulation)

Bit Rate bitrate - ⊞ - Selects the bit rate for the MP3 file type.

• 96 kb/s b96 -

• 128 kb/s b128 -

• 192 kb/s b192 -

• 256 kb/s b256 -

• 320 kb/s b320 -

Record record - When toggled on, it will open the audio file and begin recording. When toggled off, it will close the file and release the read/write lock.

Pause pause - Pauses the recording of the audio to the audio file.

Header Source DAT headerdat - The path to a Table DAT that stores header metadata that should be written to the output image or movie file. Header data is written as key-value pairs with the first column storing the keys and the second column storing the associated values. See File Metadata for more information on supported metadata.

Parameters - Common Page

Time Slice timeslice - Turning this on forces the channels to be "Time Sliced". A Time Slice is the time between the last cook frame and the current cook frame.

Scope scope - To determine which channels get affected, some CHOPs use a Scope string on the Common page.

Sample Rate Match srselect - ⊞ - Handle cases where multiple input CHOPs' sample rates are different. When Resampling occurs, the curves are interpolated according to the Interpolation Method Option, or "Linear" if the Interpolate Options are not available.

• Resample At First Input's Rate first - Use rate of first input to resample others.

• Resample At Maximum Rate max - Resample to the highest sample rate.

• Resample At Minimum Rate min - Resample to the lowest sample rate.

• Error If Rates Differ err - Doesn't accept conflicting sample rates.

Export Method exportmethod - ⊞ - This will determine how to connect the CHOP channel to the parameter. Refer to the Export article for more information.

• DAT Table by Index datindex - Uses the docked DAT table and references the channel via the index of the channel in the CHOP.

• DAT Table by Name datname - Uses the docked DAT table and references the channel via the name of the channel in the CHOP.

• Channel Name is Path:Parameter autoname - The channel is the full destination of where to export to, such has geo1/transform1:tx.

Export Root autoexportroot - This path points to the root node where all of the paths that exporting by Channel Name is Path:Parameter are relative to.

Export Table exporttable - The DAT used to hold the export information when using the DAT Table Export Methods (See above).

Operator Inputs

• Input 0: -

Info CHOP Channels

Extra Information for the Audio File Out CHOP can be accessed via an Info CHOP.

Specific Audio File Out CHOP Info Channels

• last_samples_written -

• total_samples_written -

Common CHOP Info Channels

• start - Start of the CHOP interval in samples.

• length - Number of samples in the CHOP.

• sample_rate - The samplerate of the channels in frames per second.

• num_channels - Number of channels in the CHOP.

• time_slice - 1 if CHOP is Time Slice enabled, 0 otherwise.

• export_sernum - A count of how often the export connections have been updated.

Common Operator Info Channels

• total_cooks - Number of times the operator has cooked since the process started.

• cook_time - Duration of the last cook in milliseconds.

• cook_frame - Frame number when this operator was last cooked relative to the component timeline.

• cook_abs_frame - Frame number when this operator was last cooked relative to the absolute time.

• cook_start_time - Time in milliseconds at which the operator started cooking in the frame it was cooked.

• cook_end_time - Time in milliseconds at which the operator finished cooking in the frame it was cooked.

• cooked_this_frame - 1 if operator was cooked this frame.

• warnings - Number of warnings in this operator if any.

• errors - Number of errors in this operator if any.

TouchDesigner Build: Latest\nwikieditorwikieditorwikieditorwikieditor

An Operator Family which operate on Channels (a sequence of numbers (Samples)) which are used for animation, audio, mathematics, simulation, logic, UI construction, and data streamed from/to devices and protocols.

To "pulse" a parameter is to send it a signal from (1) an exported CHOP channel or (2) a python command or (3) a mouse click that causes a new action to occur immediately. A pulse via python is via the .pulse() function on a pulse-type parameter, such as Reset parameter in a Speed CHOP. A pulse from a CHOP is typically a 0 to 1 to 0 signal in an exported channel.

An Operator Family that manipulates text strings: multi-line text or tables. Multi-line text is often a python Script or GLSL Shader, but can be any multi-line text. Tables are rows and columns of cells, each containing a text string.

A form of DATs (Data Operators) that is structured as rows and columns of text strings.

A Time Slice is the time from the last cook frame to the current cook frame. In CHOPs it is the set of short channels that contain the CHOP channels' samples between the last and the current cook frame.

A parameter in most CHOPs that restricts which channels of that CHOP will be affected. Normally all channels of a CHOP are affected by the operator. TOPs have Channel Mask, a similar feature.

samples-per-second of a CHOP. Each CHOP in your network has a sample rate. In contrast, the overall timeline has a Frame Rate, which is the number of frames to cook and display per second, generally your monitor display frequency, default 60.

Exporting is the connection of CHOP channels to parameters of operators. The output of each exporting CHOP is one or more channels, active only while the CHOP Viewer is on. The current value of a channel can be exported to a parameter of any operator, overriding that parameter's value. See Parameter.

The location of an operator within the TouchDesigner environment, for example, /geo1/circle1, a node called circle1 in a component called geo1. The path / is called Root. This path is displayed at the top of every Pane, showing which Component's network you are currently in. To refer instead to a filesystem folder, directory, disk file or http: address, see Folder.

Every operator in TouchDesigner has a set of control Parameters that can be integer or floating point numbers, menus, binary toggles, text strings or operator paths, which determine the output of the operator.

TouchDesigner is a hierarchy of components. "root" is the top-most network in the hierarchy. The Network Path or Path for root is simply /. A typical path is /project1/moviein1.