cinelerra3 Documentation

All things concering the big picture.
Not a real code package, rather a container for design drafts, specifications, decisions.

1.1 Component View Architecture

The various Components comprising the Cinelerra3 Video editing Application

Overview

This drawing shows the top level compoents and relations

Component Builder

Component Session

Component EDL

nested in Session

Component Fixture

nested in Session

Component Controller

Depends on Builder

Component AssetManagement

Component Dispatcher

Component Engine

Depends on Frame (Stream) Provider

Component Frame (Stream) Provider

Depends on Cache

Component Cache

Component RenderPathManager

1.2 Package codegen

This package is used to organize code generation by BOUML. It is considered useless after having generated the initial code skeleton.

1.2.1 Deployment View EXE Deployment

defines and lists how the Cinelerra executable has to be created

Source Overview

Artifact Cinelerra3

Depends on common

Depends on gui

Depends on proc

Depends on backend

the main executable to be built

executable associated with : mask, main, paramprovider, frame, processor, fixedplacement, glrender, glbuf, controllerfacade, meta, pluginadapter, renderstate, session, vframe, source, exitnode, fixture, track, renderengine, edl, parameter, explicitplacement, projector, builderfacade, toolfactory, buildable, clip, hub, conmanager, relativeplacement, assembler, aframe, label, tool, allocation, stateproxy, segmentationtool, pathmanager, vrender, arender, effect, pipe, interpolator, auto, mobject, placement, trafo, openglpipe, procnode, abstractmo, nodecreatertool

Artifact main

Artifact source

1.2.2 Package common

C++ namespace : lib

sourcecode package

Common library and helper classes

Diagram : Source Overview

1.2.2.1 Deployment View gen

defines source files to be generated by BOUML

1.2.3 Package backend

C++ namespace : data

sourcecode package

Data backend classes here...

1.2.3.1 Deployment View gen

1.2.4 Package proc

C++ namespace : proc

sourcecode package

All classes belonging to the (middle) processing layer

1.2.4.1 Deployment View gen

defines source files to be generated by BOUML

Artifact stateproxy

Artifact source associated with : StateProxy

Artifact controllerfacade

Artifact source associated with : ControllerFacade

Artifact frame

Artifact source associated with : Frame

1.2.4.2 Package asset

C++ namespace : asset

sourcecode package

Asset Management

1.2.4.2.1 Deployment View gen

defines source files to be generated by BOUML

1.2.4.3 Package mobject

C++ namespace : mobject

sourcecode package

MObject Subsystem
including the Session (EDL), Builder and Processing Controller

1.2.4.3.1 Deployment View gen

defines source files to be generated by BOUML

Artifact mobject

Artifact source associated with : Time, MObject

Artifact placement

Artifact source associated with : Placement

Artifact explicitplacement

Artifact source associated with : ExplicitPlacement

Artifact builderfacade

Artifact source associated with : BuilderFacade

Artifact buildable

Artifact source associated with : Buildable

Artifact parameter

Artifact source associated with : Parameter

Artifact paramprovider

Artifact source associated with : ParamProvider

Artifact interpolator

Artifact source associated with : Interpolator

1.2.4.3.2 Package session

C++ namespace : session

sourcecode package

Everything concerning the EDL and Session, within the MObject Subsystem

1.2.4.3.2.1 Deployment View gen

defines source files to be generated by BOUML

Artifact session

Artifact source associated with : Session

Artifact edl

Artifact source associated with : EDL

Artifact fixture

Artifact source associated with : Fixture

Artifact track

Artifact source associated with : Track

Artifact abstractmo

Artifact source associated with : AbstractMO

Artifact clip

Artifact source associated with : Clip

Artifact effect

Artifact source associated with : Effect

Artifact meta

Artifact source associated with : Meta

Artifact fixedplacement

Artifact source associated with : DirectPlacement

Artifact relativeplacement

Artifact source associated with : RelativePlacement

Artifact allocation

Artifact source associated with : Allocation

Artifact label

Artifact source associated with : Label

Artifact auto

Artifact source associated with : Auto

1.2.4.3.3 Package builder

C++ namespace : proc

sourcecode package

The Builder creating the Render Engine,
located within the MObject Subsystem

1.2.4.3.3.1 Deployment View gen

defines source files to be generated by BOUML

Artifact toolfactory

Artifact source associated with : ToolFactory

Artifact conmanager

Artifact source associated with : ConManager

Artifact assembler

Artifact source associated with : Assembler

Artifact tool

Artifact source associated with : Tool

Artifact segmentationtool

Artifact source associated with : SegmentationTool

Artifact nodecreatertool

Artifact source associated with : NodeCreatorTool

1.2.4.3.4 Package controller

C++ namespace : proc

sourcecode package

The Processing and Render Controller,
located within the MObject Subsystem

1.2.4.3.4.1 Deployment View gen

defines source files to be generated by BOUML

Artifact pathmanager

Artifact source associated with : PathManager

Artifact renderstate

Artifact source associated with : RenderState

1.2.4.4 Package engine

C++ namespace : engine

sourcecode package

The Core Render Engine

1.2.4.4.1 Deployment View gen

defines source files to be generated by BOUML

Artifact renderengine

Artifact source associated with : RenderEngine

Artifact processor

Artifact source associated with : Processor

Artifact exitnode

Artifact source associated with : ExitNode

Artifact procnode

Artifact source associated with : ProcNode

Artifact trafo

Artifact source associated with : Trafo

Artifact pipe

Artifact source associated with : Link

Artifact hub

Artifact source associated with : Hub

Artifact projector

Artifact source associated with : Projector

Artifact mask

Artifact source associated with : Mask

Artifact pluginadapter

Artifact source associated with : PluginAdapter

Artifact openglpipe

Artifact source associated with : OpenGLPipe

Artifact arender

Artifact source associated with : ARender

Artifact vrender

Artifact source associated with : VRender

Artifact glrender

Artifact source associated with : GLRender

Artifact aframe

Artifact source associated with : AFrame

Artifact vframe

Artifact source associated with : VFrame

Artifact glbuf

Artifact source associated with : GLBuf

Artifact source

Artifact source associated with : Source

1.2.5 Package gui

C++ namespace : gui

sourcecode package

User Interface classes go here

1.2.5.1 Deployment View gen

defines source files to be generated by BOUML

1.2.6 Package tool

sourcecode package

Tools and Utilities
(separate from the main cinelrra binary)

1.2.6.1 Deployment View gen

defines source files to be generated by BOUML

2 Package ProcessingLayer

2.1 Package AssetManager

2.2 Package MObject

2.2.1 Class View Session

Session structure

Class Session

Class EDL

Class Fixture

Class Track

Class MObject

Class Placement

Class AbstractMO

Class Clip

Class Effect

Class Meta

Class DirectPlacement

Class RelativePlacement

Class Allocation

Class Label

Class ExplicitPlacement

Class Auto

Class Wish

Class Constraint

2.2.2 Package Builder

2.2.2.1 Class View Builder Workings

build process

This figure shows the process of building and starting a RenderEngine

2.2.2.1.1 Activity building the Engine

Pre Condition :

Post Condition :

build flow

Activity action pin build Request

Direction : input

Type :

Selection :

Flow <flow>

From build Request To configure Tools

Weight :

Guard :

Selection :

Transformation :

Opaque activity action configure Tools

Defined in building the Engine

Pre Condition :

Post Condition :

Behavior :

Flow <flow>

From configure Tools To fork activity node

Weight :

Guard :

Selection :

Transformation :

2.2.2.1.1.1 Expansion region establish partitioning

Opaque activity action define segment

Defined in establish partitioning

Pre Condition :

Post Condition :

Behavior :

Activity action pin inFixture

Direction : input

Type :

Selection :

Flow <flow>

From define segment To segments

Weight :

Guard :

Selection :

Transformation :

Activity object segment Tool

Type :

Selection :

Is control type

Flow <flow>

From segment Tool To define segment

Weight :

Guard :

Selection :

Transformation :

Activity object segments

Type :

Selection :

Is control type

Activity object Fixture

Type :

Selection :

Flow <flow>

From Fixture To inFixture

Weight :

Guard :

Selection :

Transformation :

Flow <flow>

From Fixture To inFixture

Weight :

Guard :

Selection :

Transformation :

Fork activity node

Defined in building the Engine

Flow <flow>

From fork activity node To segment Tool

Weight :

Guard :

Selection :

Transformation :

Flow <flow>

From fork activity node To build Tool

Weight :

Guard :

Selection :

Transformation :

2.2.2.1.1.2 Expansion region build Processors

Activity object build Tool

Type :

Selection :

Is control type

Flow <flow>

From build Tool To create ProcNode

Weight :

Guard :

Selection :

Transformation :

Activity object segments

Type :

Selection :

Is control type

Flow <flow>

From segments To create ProcNode

Weight :

Guard :

Selection :

Transformation :

Opaque activity action create ProcNode

Defined in build Processors

Pre Condition :

Post Condition :

Behavior :

Flow <flow>

From create ProcNode To connect

Weight :

Guard :

Selection :

Transformation :

Opaque activity action connect

Defined in build Processors

Pre Condition :

Post Condition :

Behavior :

Flow <flow>

From connect To complete Render Engine

Weight :

Guard :

Selection :

Transformation :

Activity object complete Render Engine

Type :

Selection :

Is control type

Flow <flow>

From complete Render Engine To activity final

Weight :

Guard :

Selection :

Transformation :

Activity final

Defined in building the Engine

Builder Entities

Class BuilderFacade

Class ToolFactory

Class ConManager

Class Assembler

Class StateProxy

Class Buildable

Class Tool

Class SegmentationTool

Class NodeCreatorTool

2.2.3 Package Controller

2.2.3.1 Class View Controller Workings

Controller Entities

2.2.3.1.1 Activity configure Render

Pre Condition :

Post Condition :

the render configuration flow

Activity action pin Render Request

Direction : input

Type :

Selection :

Flow <flow>

From Render Request To determine Render Params

Weight :

Guard :

Selection :

Transformation :

Opaque activity action setup StateProxy

Defined in configure Render

Pre Condition :

Post Condition :

Behavior :

Flow <flow>

From setup StateProxy To build necessary?

Weight :

Guard :

Selection :

Transformation :

Decision activity node build necessary?

Defined in configure Render

Flow <flow>

From build necessary? To build Render Engine

Weight :

Guard :

OCL :
```
build necessary
```

Selection :

Transformation :

Flow <flow>

From build necessary? To merge activity node

Weight :

Guard :

OCL :
```
reuse exiting Engine
```

Selection :

Transformation :

Opaque activity action setup Build Params

Defined in configure Render

Pre Condition :

Post Condition :

Behavior :

Merge activity node

Defined in configure Render

Flow <flow>

From merge activity node To activity final

Weight :

Guard :

Selection :

Transformation :

2.2.3.1.1.1 Expansion region determine Render Params

Opaque activity action determine Render Params

Diagram : the render configuration flow

Defined in configure Render

Pre Condition :

Post Condition :

Behavior :

Flow <flow>

From determine Render Params To setup StateProxy

Weight :

Guard :

Selection :

Transformation :

Opaque activity action build Render Engine

Defined in configure Render

Pre Condition :

Post Condition :

Behavior :

Flow <flow>

From build Render Engine To merge activity node

Weight :

Guard :

Selection :

Transformation :

Activity final

Defined in configure Render

Class ControllerFacade

Class PathManager

Class RenderState

2.3 Package RenderEngine

2.3.1 Deployment View Engine Parts

Overview Render Engine

Node timeline

Node playlist

Node proc

Node pnode

Node Frame

Node State

2.3.2 Class View Engine Workings

Render Entities

Automation Entities

Class RenderEngine

Class Processor

Class ExitNode

Class ProcNode

Class Trafo

Class Link

Class Hub

Class Projector

Class Mask

Class PluginAdapter

Class OpenGLPipe

Class ARender

Class VRender

Class GLRender

Class Frame

Class AFrame

Class VFrame

Class GLBuf

Class Source

Class Parameter

Class ParamProvider

Class Interpolator

2.4 Use Case View Renderengine Use

EDL Example1

A simple example showing how the actual objects are placed in the Fixture (=definitive playlist). It shows a Video and Audio clip placed on two tracks

EDL Example2

More complex example showing the Object graph in the EDL and how it is linked into the Fixture to yield the actual locations. In this example, an HUE Effect is applied on a part of the Clip

Engine Example1

Example1 (from EDL) continued: here the RenderEngine to be created by the Builder from the Input shown in Example1

Engine Example2

Example2 (from EDL) continued: notably in this RenderEngine the Effect has been partitioned into 2 segments with constant configuration.

Class instance

type :Fixture

Class instance

type :ExplicitPlacement

attributes :

time = 2
track = video1

Class instance

type :ExplicitPlacement

attributes :

time = 2
track = audio1

Class instance audio1

type :Track

Class instance video1

type :Track

Class instance vid_A

type :Clip

attributes :

length = 5
start = 100

Class instance aud_A

type :Clip

attributes :

length = 8820
start = 176400

Class instance audio1

type :Track

Class instance

type :ExplicitPlacement

attributes :

time = 2
track = video1

Class instance video1

type :Track

Class instance

type :Fixture

Class instance vid_A

type :Clip

attributes :

length = 5
start = 100

Class instance

type :EDL

Class instance refPoint

type :Label

attributes :

length = 0

Class instance

type :Allocation

attributes :

repr = "t=2"

Class instance vid_A

type :Clip

attributes :

length = 5
start = 100

relations :

placement = class instance

Class instance

type :RelativePlacement

attributes :

relType = SAMETIME

relations :

subject = vid_A
anchor = refPoint

Class instance

type :Effect

attributes :

length = 3
plugID = "Hue"

relations :

placement = class instance

Class instance

type :RelativePlacement

attributes :

offset = +3
relType = ATTACH

relations :

Class instance

type :Effect

attributes :

length = 3
plugID = "Hue"

relations :

placement = class instance

Class instance

type :ExplicitPlacement

attributes :

time = 5
track = video1

Class instance

type :RenderEngine

relations :

renderSegments = video1

Class instance audio1

type :Processor

attributes :

end = 7/25
start = 2/25

relations :

output = audio

Class instance video1

type :Processor

attributes :

end = 7/25
start = 2/25

relations :

output = video

Class instance video

type :ExitNode

relations :

datasrc = ouput

Class instance audio

type :ExitNode

relations :

datasrc = aud_a

Class instance ouput

type :Projector

relations :

datasrc = class instance

Class instance input

type :Projector

relations :

datasrc = vid_a

Class instance

type :Mask

relations :

datasrc = input

Class instance vid_a

type :Source

Class instance aud_a

type :Source

Class instance vid1

type :VRender

relations :

currFrame = class instance

Class instance au1

type :ARender

relations :

currFrame = class instance

Class instance

type :VFrame

Class instance

type :AFrame

Class instance

type :RenderEngine

relations :

renderSegments = video1

Class instance devnull

type :Source

Class instance video

type :ExitNode

relations :

datasrc = HUE

Class instance input

type :Projector

relations :

datasrc = vid_a

Class instance video1

type :Processor

attributes :

end = 8/25
start = 7/25

relations :

output = video

Class instance ouput

type :Projector

relations :

datasrc = HUE

Class instance HUE

type :PluginAdapter

relations :

datasrc = input

Class instance vid1

type :VRender

relations :

currFrame = class instance

Class instance

type :VFrame

Class instance video1

type :Processor

attributes :

end = 7/25
start = 5/25

relations :

output = video

Class instance video

type :ExitNode

relations :

datasrc = ouput

Class instance HUE

type :PluginAdapter

relations :

datasrc = devnull

Class instance vid_a

type :Source

Class instance input

type :Projector

relations :

datasrc = vid_a

Class instance video1

type :Processor

attributes :

end = 5/25
start = 2/25

relations :

output = video

Class instance ouput

type :Projector

relations :

datasrc = input

Class instance video

type :ExitNode

relations :

datasrc = ouput

3 Package BackendLayer

3.1 Package design

3.1.1 Class View Backend Components

File Mapping

Shows whats used to access Frames

In Memory Database

Class File

Class FileHandleCache

Class FileMapCache

Class FileMap

Class FileHandle

Class Frame

Class FrameDescriptor

Class Prefetch

Class Scheduler

Class FileProvider

Class FrameReference

Class FileReference

3.1.1.1 Activity get frame

Pre Condition :

Post Condition :

3.2 Component View Cache

3.3 Component View FileMapping

4 Package GUI

GUI is here just a container to hold any entities considered to be User Interface related, which is not in focus for this Design draft

1 Package design

1.1 Component View Architecture

1.2 Package codegen

1.2.1 Deployment View EXE Deployment

1.2.2 Package common

1.2.2.1 Deployment View gen

1.2.3 Package backend

1.2.3.1 Deployment View gen

1.2.4 Package proc

1.2.4.1 Deployment View gen

1.2.4.2 Package asset

1.2.4.2.1 Deployment View gen

1.2.4.3 Package mobject

1.2.4.3.1 Deployment View gen

1.2.4.3.2 Package session

1.2.4.3.2.1 Deployment View gen

1.2.4.3.3 Package builder

1.2.4.3.3.1 Deployment View gen

1.2.4.3.4 Package controller

1.2.4.3.4.1 Deployment View gen

1.2.4.4 Package engine

1.2.4.4.1 Deployment View gen

1.2.5 Package gui

1.2.5.1 Deployment View gen

1.2.6 Package tool

1.2.6.1 Deployment View gen

2 Package ProcessingLayer

2.1 Package AssetManager

2.2 Package MObject

2.2.1 Class View Session

2.2.2 Package Builder

2.2.2.1 Class View Builder Workings

2.2.2.1.1 Activity building the Engine

2.2.2.1.1.1 Expansion region establish partitioning

2.2.2.1.1.2 Expansion region build Processors

2.2.3 Package Controller

2.2.3.1 Class View Controller Workings

2.2.3.1.1 Activity configure Render

2.2.3.1.1.1 Expansion region determine Render Params

2.3 Package RenderEngine

2.3.1 Deployment View Engine Parts

2.3.2 Class View Engine Workings

2.4 Use Case View Renderengine Use

3 Package BackendLayer

3.1 Package design

3.1.1 Class View Backend Components

3.1.1.1 Activity get frame

3.2 Component View Cache

3.3 Component View FileMapping

4 Package GUI

5 Package CommonLib

5.1 Class View Service Components

5.2 Class View Posix Threads Abstraction

5.3 Class View SmartPointers