Video Player

Video player module.

About compression format

The codec used for the video compression is very important. To explain simply, acompressed video flow is made of key frames, also known as an intra-frames followed by modified frames. A key frame is a frame in which a complete image is stored in the data stream. In video compression, only changes that occur from one frame to the next are stored in the data stream, in order to greatly reduce the amount of information that must be stored. See Wikipedia.

This means that, in a compressed video, you can't access directly to any frame but only key frames which can occur, for example only every seconds.

Another consequence is that a compressed video can't be played in reverse.

If you want to play a video in reverse, you must export it into separate images and use the video-player-image module.

If you want to access to any frames at any time, you can use uncompressed videos or use motion-jpeg compression. The motion jpeg format contains only key frames.

You can use a conversion tools to convert you videos to motion-jpeg, for example the free FFmpeg, and use the following command line:

ffmpeg -i input.mov -c:v mjpeg -q:v 3 -an output.mov

Settings

on

Activates or deactivates the module.

video out

Video output flow(s).

show list

Shows the files list.

dimmer

Output ntensity.

speed

Sets the video reading speed.

master SMPTE

When On, the master SMPTE follows the current SMPTE.

play loop

Plays the file in loop mode until you stop it.

loop mode

Synchronization options:

  • Free loop: the file is played in loop mode.
  • Cycle: the file is played at each beginning cycle.
  • Bar: the file is played at each beginning bar.
  • Beat: the file is played each beat.
  • Eighth note: the file is played each eighth note.
  • Sixteenth note: the file is played each sixteenth note.
  • 2 bars : the file is played every 2 bars.
  • 4 bars : the file is played every 4 bars.
  • 6 bars : the file is played every 6 bars.
  • 8 bars : the file is played every 8 bars.
  • 10 bars : the file is played every 10 bars.
  • 12 bars : the file is played every 12 bars.
  • 14 bars : the file is played every 14 bars.
  • 16 bars : the file is played every 16 bars.
  • loop on bar: the file is played entirely as in loop mode, and then, at the end, restarts at the beginning of the next bar.
  • loop on beat: the file is played entirely as in loop mode, and then, at the end, restarts at the beginning of the next beat.

auto restart

Forces to restart from the beginning, on play or on activation of the patch.

play

Plays the file.

Only when the play loop is OFF.

play button mode

  • play-replay:first click play the file (once) second click restart the file.
  • play-stop:first click play the file (once) second click stop the file.

stop

Stops the file.

Only when the play loop switch is OFF.

on activation

  • do nothing: When parent patch is activated nothing is done nothing special done.
  • play once: When patch activated the file is played once.

at the end

Determines what happens when the sample or MIDI sequence reach it's end:

  • do nothing: nothing is done.
  • next grid section: the grid goes to the next section.

is playing

Sends a 1 value when the module is playing. 0 otherwise.

re-start trigger

Sends 1 value each time the current file is starting or re-starting.

Works properly only when loop mode = synchro.

freez frame on stop

If ON, freezes the last frame when the player stops.

pause

Pauses the playing (stops without restarting from the beginning)

original duration

Original file duration before the pitch is applied.

nb of channels

Gets the number of audio channels of the selected file.

  • 1 : mono,
  • 2 : stereo,
  • 4 : surround 4 channels,
  • etc.

fps

Frame Rate (Number of Frames per seconds) of the original video.

duration

Video duration in ms of the video.

the duration is calculated according the speed, start pos, end pos parameters.

original duration

Video duration in ms of the entire video.

unlike the duration the original duration doesn't take care of the speed, start pos, end pos parameters.

nb of frames

Gets the number of frames of the current file.

codec

Name of the video codec.

size reduction factor

Reduction size factor applied to the original size of the video.

  • 1: no size reduction
  • 3/4: reduction by 3/4
  • etc.

This is useful to

  • reduce the size of video and therefore reduce the CPU consumption of video filters,
  • fit to the output display resolution.

This can reduce efficiently the number of pixels to process in the video flow and then reduce the CPU load of video effects.

A 1920 × 1080 (2073600 pixels per frame) video with a size factor of 2/3 gives a 1280 x 720 resolution (921600 pixel per frame) so the CPU load will be reduced by 50%.

width

Video resolution width (once reduction factor applied).

height

Video resolution height (once reduction factor applied).

start pos

Start reading position.

end pos

End reading position.

the file is read between the start and end position

pos

Sets or gets the current reading position.

The pos inlet is not suitable for precise random access to file position, use current frame num instead.

current frame num

Gets or set the current frame number.

The current frame num inlet can be used for precise random access to file position, especially if you set speed=0 and only for motion-jpeg or uncompressed videos. See About compression format above.

jump to key frames

Jump the reading position only to Key frames when pos or current frame num are changed. See About compression format above.

next

Selects the next file in the list.

previous

Selects the previous file in the list.

next rand

Random selection of a file in the list.

short filename

Gives only the name of the file, without the path and extension.

long filename

Gives the full name of the file, included the path.

add file name

Set this value with a filename to add a new file in the list (this applies to the sampler, video player and piano roll).

list comma text

Input to set the file list with a comma-text.

clear list

Clears the files list. When you press saverand or savename the recorded file is automatically added to the files list. With the clear list button you can clear the list directly.

clear last

Deletes the last element of the files list

user curve

Output value of the user curve. Can be used to synchronize processing with the current video.

thumbnail out

Thumbnail video output: size reduced version as appears in the video panel.

saved in preset

Determines if parameters of this object are saved in the preset-panel.

fade preset

Parameters of the this object can cross faded when you recall a preset in the grid.

Optional setting, does not appear on all objects.

hint

Hint text displayed on mouse over.

Other Settings

background

background color

Background color of the control.

transparent option must be OFF.

Blue background color example.

transparent

Determines if the background of the control is transparent or not.

Example, the first module is transparent.

hilited color

Background color when the control is modified by a remote (MIDI,OSC,etc.).

image file

Optional Filename of the background image.

Only PNG, JPEG and BMP formats are supported.

Use [ctrl+click] to reset.

Example on an panel-xy-pad.

fit size

Force the image file to adapt its displayed size to the size of the object.

  • proportional: the image keeps its proportion ratio and is left aligned,
  • scaled: the image is scaled to the object size,
  • original: keeps the original size, the object is resized,
  • clipped: the image is clipped to the object size, and centered.

Bitmaps

bitmap in

Background bitmap input.

Use [CTRL + Click] to reset the input.

bitmap out

Background bitmap output.

border

show border

Displays or not the border of the control.

8 pixels border on an panel-xy-pad.

border width

Sets the border width of the control in pixel.

8 pixels border on an panel-xy-pad.

border color

Border color of the control.

a yellow border on an panel-xy-pad.

border OFF color

Border color when the control is OFF.

a black OFF border on a switch.

border ON color

Border color when the control is ON.

a white ON border on a switch.

round size

Thickness of rounded corners.

0 = no rounded corners.

Example on a panel-shape.

don't draw selection border

Enables or disables the drawing of a border when the control is selected with the mouse.

caption

show caption

Displays or not the caption.

Example on a fader.

caption align

Caption alignement of the control : Left, center or right.

caption V align

Vertical alignment of the caption: Center, top or bottom.

Example on knob: Center, top and bottom.

Example on switch.

caption font size factor

Size multiplication factor applied to the caption font.

Example on switch.

caption font

Font name of the control caption.

Example with 3 different fonts on switch.

caption font color

Color of the caption font.

Example on switch.

caption font italic

Italic style for caption font.

Example on switch.

caption font bold

Bold style for caption font.

Example on switch.

caption font underline

Underline style for the caption font.

Example on switch.

drag & drop

drag enabled

Enables the drag on this control.

allow drop

Enables or disables the drag&drop possibilities on this control.

drop file name

Name of the dropped file.

clear drop file name

Clears the latest dropped file name.

global

edition enabled

Determines if the control can be modified by the user. When OFF, the mouse interaction and modifications are disabled so the user can't change the value.

is visible

Sets or get the visibility of the control.

global color

Global color of the control. Usine will choose the best contrasted colors according the global color.

on top

Determines the Z-order of the control

  • normal: the Z-order is the control creation order
  • on top: the control appears always on top of all other controls
  • backward: the control appears always behind all other controls

Example with the first knob on top.

opacity

Opacity value of the control.

0 will give a totally transparent control so invisible.

blur softness

Blur amount applied to the object.

Example of blur.

Be careful, the blur softness use shaders which are not supported by all graphic cards.
It can crashe Usine.

header

show header

Displays or not the header on the panel.

Example on sequenced-lines.

header height

Height of the header in pixels.

header color

Background color of the header.

horizontal-scroller

show H scroller

Determines if the horizontal scroller is visible or not.

The scroller appears only if the container is smaller than the controls inside.

Example of horizontal scroller

H scroller height

Height of the scroller in pixels.

H scroller color

Scroller color.

H scroller opacity

Scroller opacity.

ID's

visible only in god mode, see setup-panel-tab-expert.

unique ID

Current private id for this control.

recreate ID

If you experience difficulties in Polyphonic mode, try to recreate new id(s) with this button.

repair ID s

Each Patch shared on the local network uses its own ID (identification number). If you experience issues of Patches that don't send information to the good target, this button will rebuild all these id’s.

info

show info

Opens the web browser to display informations or help about the selected object, if it exists.

For more details about information/help creation, see create-help-file.

location

where

Determines where the object is visible:

  • invisible: the object is invisible.
  • ctrl panel: in the control-panel.
  • parent ctrl panel: in the control-panel of the parent patch if it exists.
  • top ctrl panel : in the control-panel of the top parent patch (main patch) if it exists.
  • container : in the container of the current patch.
  • parent container : in the container of the parent patch of the current patch.
  • top parent container: in the container of the top parent patch of the current patch.
  • pop up window: visible in the popup.
  • top header: visible in the top top-header-panel.
  • toolbox: visible in the toolbox-panel.
  • workspace: visible in the workspace-panel.

When the location is set to a container which doesn't exist in the patch, Usine try to find in parent patches, the first container available. If no container is available an error message is displayed.

also visible in IB

When ON, will also be visible in the interface-builder-panel.

mouse

mouse dwn

Gives the mouse state of the control:

  • 1 if the mouse is pressed
  • 0 otherwise.

In multi-touch environment, can be an array of [0..1] values.

mouse wheel

Gives the mouse wheel direction:

  • -1 = forward,
  • 1 = backward.

dbl click

Sends a 1 value if the user has [dbl-clicked] on the control.

mouse y

Gives the mouse X position on the control in relative coordinates:

  • 0 = most left,
  • 1 = most right.

In multi-touch environment, can be an array of [0..1] values.

mouse x

Gives the mouse Y position on the control in relative coordinates:

  • 0 = top,
  • 1 = bottom.

In multi-touch environment, can be an array of [0..1] values.

touch pressure

Pressure value on touch-screens. !!!!The pressure value is not available on all touch screens.

gesture

Gesture information's.

In touch and multi-touch environment, returns an array of the fingers movements See multi-touch

auto reset

When ON, the value of the control is reset automatically on mouse up.

vertical mouse

When ON, move up-down to rotate a knob, left-right when OFF.

mouse over

Sends a 1 value when the control is hovered with the mouse.

mouse over

Sends 1 when the control is mouse overed.

selected

Sends 1 when the control is selected.

Size, positions

top

Top position of the control in pixels.

left

Left position of the control in pixels.

height

Height of the control in pixels.

width

Width of the control in pixels.

position x

Horizontal position in % [0..1] relative to the parent panel.

position y

Vertical position in % [0..1] relative to the parent panel.

heightpc

Height in % [0..1] relative to the parent panel.

widthpc

Width in % [0..1] relative to the parent panel.

IB top

Top position in pixels in the interface-builder-panel.

IB left

Left position in pixels in the interface-builder-panel.

IB width

Width in pixels in the interface-builder-panel.

IB height

Height in pixels in the interface-builder-panel.

rotation angle

Rotation angle of the control.

vertical

Rotates this control in vertical position.

zoom scale

Zoom scale of the control.

can zoom

Determines is the control can be zoomed with the wheel mouse.

resize grip enabled

Determines if the control can be resized with the resize grip.

minimized

Determines if the control is minimized or not.

floating x

Determines if the control is movable on X axis.

floating y

Determines if the control is movable on Y axis.

floating content parent x

When ON the control stays inside the parent on X axis.

floating content parent y

When ON the control stays inside the parent on Y axis.

TpgControl_Button.floating content parent y

resizable left

Determines if the control can be resized on its left hand.

resizable right

Determines if the control can be resized on its right hand.

resizable top

Determines if the control can be resized on its top hand.

resizable bottom

Determines if the control can be resized on its bottom hand.

Physics-engine

physics enabled

Enables physics-engine in this panel.

physics speed

The physics speed of the control in physics-engine.

init with random speed

When ON, the physics-engine starts with a random speed for each child controls.

same masses

When ON, all controls have the same masses in the physics-engine.

ignored in physical engine

The position control is not affected by the physics-engine.

friction

Friction factor in the physics-engine.

elasticity

Energy conservation coefficient on collision.

gravity x

Gravity factor on the X axis.

gravity y

Gravity factor on the Y axis.

reset pos x

Position of the object when the physics engine is reset on X axis.

reset pos y

Position of the object when the physics engine is reset on Y axis.

angular speed

Angular speed of the control in the physical engine.

collide

Sends a 1 value when the control collides with another control or a border.

collide info

Gives information about the collide state in the physics-engine:

  • 1001: top of the parent,
  • 1002: right side of the parent,
  • 1003: left side of the parent,
  • 1004: bottom of the parent.

speed x

Speed vector value on the X axis in the physics-engine.

speed y

Speed vector value on the Y axis in the physics-engine.

Layouts

auto reorganize

Automatically reorganize positions of controls in the panel.

reorganize margin

Left margin used in reorganization, in pixels.

reorganize interspace

Interspace between controls used in reorganization, in pixels.

auto resize

Resizes panels automatically when child controls are moved or resized. !!!!Switch it OFF if you use floating panels inside.

auto resize margin

Margin in pixel used for the auto resize option.

fit standard size

Adjust the panel width to a multiple of the default rack width.

snap to grid

In unlock mode, snap the control to a grid.

grid size

Grid size in pixels when snap to grid is ON.

toolbar

show toolbar

Displays the toolbar with its icons.

Example ON and OFF

toolbar size factor

Height of the toolbar % of the global height.

Example toolbar size on a panel.

Cursor

show cursor

Displays a small cursor indicator at current position.

cursor color

Color of the cursor.

cursor width

Cursor width in pixels.

2 and 8 pixels cursor on a data-generator-sequenced-steps.

cursor opacity

Opacity of the cursor.

See also

version 5.0.210914

Edit All Pages