diff --git a/doc/devel/uml/class128005.html b/doc/devel/uml/class128005.html index 9ee1b55a0..fabe77cf9 100644 --- a/doc/devel/uml/class128005.html +++ b/doc/devel/uml/class128005.html @@ -4,21 +4,22 @@ -Class Session +Class SessionImpl -
Class Session
+
Class SessionImpl

-

Declaration :

Artifact : session, Component(s) : Session

+

Declaration :

Implementation class for the Session interface

Artifact : sessionimpl, Component(s) : Session

-
Relation edls (<directional aggregation>)

Declaration :

+
Relation edls (<directional aggregation by value>)

Declaration :

Relation fixture (<unidirectional association>)

Declaration :

+

All public operations : currEDL , getFixture

diff --git a/doc/devel/uml/class138501.html b/doc/devel/uml/class138501.html index 03c3ffaa4..fd0b56e89 100644 --- a/doc/devel/uml/class138501.html +++ b/doc/devel/uml/class138501.html @@ -16,7 +16,7 @@ -

Declaration :

compound of several elementary media tracks,
e.g. the individual media streams found in one media file

+

Declaration :

compound of several elementary media tracks,
e.g. the individual media streams found in one media file

Artifact : compoundmedia

Relation tracks (<directional aggregation>)

Declaration :

  • Uml : # tracks : Media, multiplicity : 1..*
  • C++ : protected: vector<Media *> tracks

elementary media assets comprising this compound

All public operations : createClip , enable , getDependant , getParents , howtoProc , isActive

diff --git a/doc/devel/uml/class138629.html b/doc/devel/uml/class138629.html index e8d6b1276..9bc8209f7 100644 --- a/doc/devel/uml/class138629.html +++ b/doc/devel/uml/class138629.html @@ -16,7 +16,7 @@ -

Declaration :

Diagram : Session structure

+

Declaration :

  • C++ : class CompoundClip : public Clip

Clip MObject which is actually a compound of several elementary clips,
e.g. the several streams found within multichannels media.

Artifact : compoundclip, Diagram : Session structure

Relation components (<directional aggregation>)

Declaration :

  • Uml : # components : Clip, multiplicity : 1..*
  • C++ : protected: Clip* components

All public operations : apply

diff --git a/doc/devel/uml/class138757.html b/doc/devel/uml/class138757.html index 532214425..d4594382d 100644 --- a/doc/devel/uml/class138757.html +++ b/doc/devel/uml/class138757.html @@ -16,7 +16,7 @@ -

Declaration :

  • C++ : class ProcPatt : public Struct
+

Declaration :

  • C++ : class ProcPatt : public Struct

special type of structural Asset representing information how to build some part of the render engine's processing nodes network.

Artifact : procpatt

Relation instructions (<directional aggregation by value>)

Declaration :

All public operations : enable , getDependant , getParents , isActive

diff --git a/doc/devel/uml/class138885.html b/doc/devel/uml/class138885.html index 598ee1c5b..987c50371 100644 --- a/doc/devel/uml/class138885.html +++ b/doc/devel/uml/class138885.html @@ -16,7 +16,7 @@ -

Declaration :

  • C++ : class SimpleClip : public Clip
+

Declaration :

  • C++ : class SimpleClip : public Clip

Elementary clip consisting of only one media stream

Artifact : simpleclip

All public operations : apply

diff --git a/doc/devel/uml/class139013.html b/doc/devel/uml/class139013.html index 911e23339..9c8b83182 100644 --- a/doc/devel/uml/class139013.html +++ b/doc/devel/uml/class139013.html @@ -17,5 +17,5 @@

Declaration :

  • C++ : class BuildInstruct

Directly inherited by : DoAttach DoRecurse

- +

(Interface) building instructions to be executed by the Builder on the render node network under construction.

Artifact : buildinstruct

diff --git a/doc/devel/uml/class139141.html b/doc/devel/uml/class139141.html index 1a1d63db8..e1b79bcb6 100644 --- a/doc/devel/uml/class139141.html +++ b/doc/devel/uml/class139141.html @@ -16,7 +16,7 @@ -

Declaration :

+

Declaration :

Artifact : buildinstruct

Relation nodes (<directional aggregation>)

Declaration :

  • Uml : + nodes : Proc, multiplicity : 1..*
  • C++ : public: const Proc* nodes
Attribut point
diff --git a/doc/devel/uml/class139269.html b/doc/devel/uml/class139269.html index 3e1dd987b..4ec293ab8 100644 --- a/doc/devel/uml/class139269.html +++ b/doc/devel/uml/class139269.html @@ -16,7 +16,7 @@ -

Declaration :

+

Declaration :

Artifact : buildinstruct

Relation subPattern (<unidirectional association>)

Declaration :

  • Uml : # subPattern : ProcPatt, multiplicity : 1
  • C++ : protected: const ProcPatt* subPattern
diff --git a/doc/devel/uml/class139525.html b/doc/devel/uml/class139525.html index e5acd9bec..603d8d16b 100644 --- a/doc/devel/uml/class139525.html +++ b/doc/devel/uml/class139525.html @@ -16,5 +16,5 @@ -

Declaration :

  • C++ : class MediaAccessFacade

provides functions for querying (opening) a media file, detecting the channels or streams found within this file, etc. Delegating to the actual backend functions

Component(s) : Media Access

+

Declaration :

  • C++ : class MediaAccessFacade

provides functions for querying (opening) a media file, detecting the channels or streams found within this file, etc. Delegating to the actual backend functions

Artifact : mediaaccessfacade, Component(s) : Media Access

diff --git a/doc/devel/uml/class139653.html b/doc/devel/uml/class139653.html new file mode 100644 index 000000000..d23ad4ec8 --- /dev/null +++ b/doc/devel/uml/class139653.html @@ -0,0 +1,26 @@ + + + + + + +Class Session + + + + + +
Class Session
+

+ + + + +

Declaration :

  • C++ : class Session

Directly inherited by : SessionImpl

+

Primary Interface for all editing tasks.
The session contains defaults, all the assets being edited, and a set of EDL with the individual MObjects to be manipulated and rendered.

Artifact : session

+ +
Operation currEDL

Declaration :

  • Uml : + currEDL() : EDL
  • C++ : public: EDL currEDL ()

The EDL currently in focus. In most cases, Session and EDL are almost the same, just EDL emphasizes the collection aspect. But generally (for larger editing projects) one Session can contain several EDLs, which may even be nested. At any given time, only one of these EDLs has focus and recieves the editing commands.

+
Operation getFixture

Declaration :

  • Uml : + getFixture() : Fixture&
  • C++ : public: Fixture& getFixture ()

While the session can be comprised of several EDLs,
there is only one Fixture, which represents the actual
configuration of all Objects to be rendered

+

All public operations : currEDL , getFixture

+ + diff --git a/doc/devel/uml/classes.html b/doc/devel/uml/classes.html index a34ff3876..f3008a1a0 100644 --- a/doc/devel/uml/classes.html +++ b/doc/devel/uml/classes.html @@ -27,13 +27,13 @@ AutoAutomation data for some parameter (i.e. a time varying function) Buildableinterface BuilderFacadeboundaryProvides unified access to the builder functionality. While individual components of the builder subsystem may be called if necessary or suitable, it is usually better to do all extern invocations via the high level methods of this Facade -BuildInstruct +BuildInstruct(Interface) building instructions to be executed by the Builder on the render node network under construction. Categorytree like classification of Assets Clipbookkeeping (asset) view of a media clip. Clip Codecdescription of some media data decoder or encoder facility CodecAdapter -CompoundClip +CompoundClipClip MObject which is actually a compound of several elementary clips,
e.g. the several streams found within multichannels media. CompoundMediacompound of several elementary media tracks,
e.g. the individual media streams found in one media file ConditionI provided a reworked Condition class in my cinelerra2 repository Config @@ -96,7 +96,7 @@ Prockey abstraction: data processing asset Processor ProcNodeinterfaceKey abstraction of the Render Engine: A Data processing Node -ProcPatt +ProcPattspecial type of structural Asset representing information how to build some part of the render engine's processing nodes network. ProjectorSpecial video processing node used to scale and translate image data. RelativePlacement RelTypeenumthe possible kinds of RelativePlacements @@ -105,8 +105,9 @@ Scheduler Segment SegmentationToolTool implementation for deriving a partitioning of the current timeline such, that each segement has a constant configuration. "Constant" means here, that any remaining changes over time can be represented by automation solely, without the need to change the node connections. -Session -SimpleClip +SessionPrimary Interface for all editing tasks.
The session contains defaults, all the assets being edited, and a set of EDL with the individual MObjects to be manipulated and rendered. +SessionImplImplementation class for the Session interface +SimpleClipElementary clip consisting of only one media stream SmartPointerauxiliary SourceSource Node: represents a media source to pull data from. State diff --git a/doc/devel/uml/classes_list.html b/doc/devel/uml/classes_list.html index b394be64d..a97c2af5b 100644 --- a/doc/devel/uml/classes_list.html +++ b/doc/devel/uml/classes_list.html @@ -106,7 +106,8 @@ Scheduler
Segment
SegmentationTool
-Session
+Session
+SessionImpl
SimpleClip
SmartPointer
Source
diff --git a/doc/devel/uml/fig128133.png b/doc/devel/uml/fig128133.png index 1b1f3347e..68a34623f 100644 Binary files a/doc/devel/uml/fig128133.png and b/doc/devel/uml/fig128133.png differ diff --git a/doc/devel/uml/index.html b/doc/devel/uml/index.html index 6e665f205..fdd9b2654 100644 --- a/doc/devel/uml/index.html +++ b/doc/devel/uml/index.html @@ -33,10 +33,10 @@ Documentation
Component Builder

provided classes : StateProxy

-

required classes : Fixture, Session

+

required classes : Fixture, SessionImpl

Component Session
-

provided classes : EDL, Fixture, MObject, ParamProvider, Session

+

provided classes : EDL, Fixture, MObject, ParamProvider, SessionImpl

Component EDL
@@ -112,7 +112,7 @@ Documentation
Artifact Cinelerra3

Depends on common

Depends on gui

Depends on proc

Depends on backend

the main executable to be built

-

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

+

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

Artifact main

Artifact source

@@ -150,11 +150,17 @@ Documentation

1.3.3 Package backend

    -
  • C++ namespace : data
    • +
  • C++ namespace : backend_interface

sourcecode package

Data backend classes here...

1.3.3.1 Deployment View gen

+
+ +
Artifact mediaaccessfacade
+

functions for querying media file and channels.

+

Artifact source associated with : MediaAccessFacade

+

1.3.4 Package proc

@@ -225,6 +231,10 @@ Documentation
Artifact clip

bookkeeping (asset) view of a media clip.

Artifact source associated with : Clip

+ +
Artifact compoundmedia
+

a special clip as a compound of several elementary media tracks,
e.g. the individual media streams found in one media file

+

Artifact source associated with : CompoundMedia

Artifact preview

alternative version of the media data, probably with lower resolution

@@ -249,6 +259,14 @@ Documentation
Artifact track

structural asset holding the configuration of a track in the EDL

Artifact source associated with : Track

+ +
Artifact procpatt
+

template for building some render processing network

+

Artifact source associated with : ProcPatt

+ +
Artifact buildinstruct
+

Instructions for building some configuration of render nodes.

+

Artifact source associated with : BuildInstruct, DoRecurse, DoAttach

Artifact db

registry holding known Asset instances.

@@ -265,6 +283,10 @@ Documentation

1.3.4.3.1 Deployment View gen

defines source files to be generated by BOUML

+ +
Artifact session
+

Interface: the session edited by the user

+

Artifact source associated with : Session

Artifact mobject

Key Abstraction: A Media Object in the Session

@@ -309,9 +331,9 @@ Documentation

defines source files to be generated by BOUML

-
Artifact session
-

holds the complete session to be edited by the user

-

Artifact source associated with : Session

+
Artifact sessionimpl
+

holds the complete session data to be edited by the user

+

Artifact source associated with : SessionImpl

Artifact edl

the (high level) Edit Decision List within the current Session

@@ -336,6 +358,14 @@ Documentation
Artifact clip

a Media Clip

Artifact source associated with : Clip

+ +
Artifact simpleclip
+

Elementary clip (single media stream only)

+

Artifact source associated with : SimpleClip

+ +
Artifact compoundclip
+

compound of several clips (multichannel)

+

Artifact source associated with : CompoundClip

Artifact effect

EDL representation of a pluggable and automatable effect.

@@ -568,7 +598,6 @@ Documentation
Class ProcPatt
Class Dataset
Class DB
-
Class SimpleClip
Class BuildInstruct
Class DoAttach
Class DoRecurse
@@ -583,7 +612,8 @@ Documentation

Session structure



-
Class Session
+
Class Session
+
Class SessionImpl
Class EDL
Class Fixture
Class Segment
@@ -593,6 +623,7 @@ Documentation
Class ExplicitPlacement
Class AbstractMO
Class Clip
+
Class SimpleClip
Class CompoundClip
Class Effect
Class Meta
diff --git a/doc/devel/uml/index_60.html b/doc/devel/uml/index_60.html index 4909e634c..0a78be5d0 100644 --- a/doc/devel/uml/index_60.html +++ b/doc/devel/uml/index_60.html @@ -28,8 +28,8 @@ <flow>transition <flow>transition <flow>transition -<flow>transition <flow>transition +<flow>transition <flow>transition <flow>transition <flow>transition diff --git a/doc/devel/uml/index_65.html b/doc/devel/uml/index_65.html index 7fc8a769c..28aa29de6 100644 --- a/doc/devel/uml/index_65.html +++ b/doc/devel/uml/index_65.html @@ -49,11 +49,11 @@ Assetsclass view ATTACHattributeattach subject to anchor (e.g. an effect to a clip) au1class instance -aud_aclass instance aud_Aclass instance +aud_aclass instance audioclass instance -audio1class instance audio1class instance +audio1class instance audio1class instance autoartifactMedia Object holding automation data AutoclassAutomation data for some parameter (i.e. a time varying function) diff --git a/doc/devel/uml/index_66.html b/doc/devel/uml/index_66.html index 2f6812bb3..5ed3d76c4 100644 --- a/doc/devel/uml/index_66.html +++ b/doc/devel/uml/index_66.html @@ -41,7 +41,8 @@ BuilderFacadeclassProvides unified access to the builder functionality. While individual components of the builder subsystem may be called if necessary or suitable, it is usually better to do all extern invocations via the high level methods of this Facade builderfacadeartifactFacade and service access point for the Builder Subsystem building the Engineactivity -BuildInstructclass +BuildInstructclass(Interface) building instructions to be executed by the Builder on the render node network under construction. +buildinstructartifactInstructions for building some configuration of render nodes. buildProcessoroperation diff --git a/doc/devel/uml/index_67.html b/doc/devel/uml/index_67.html index d9c7fd522..b81c28c53 100644 --- a/doc/devel/uml/index_67.html +++ b/doc/devel/uml/index_67.html @@ -27,12 +27,11 @@ checked_outrelationthis list keeps all mappings which are in use, and thus prevents them from Cache aging Cinelerra3artifactthe main executable to be built cinelerra3package -class instanceclass instance -class instanceclass instance -class instanceclass instance class instanceclass instance -class instanceclass instance +class instanceclass instance +class instanceclass instance class instanceclass instance +class instanceclass instance class instanceclass instance class instanceclass instance class instanceclass instance @@ -40,14 +39,15 @@ class instanceclass instance class instanceclass instance class instanceclass instance -class instanceclass instance -class instanceclass instance -class instanceclass instance -class instanceclass instance class instanceclass instance +class instanceclass instance +class instanceclass instance +class instanceclass instance +class instanceclass instance +class instanceclass instance Clipclassbookkeeping (asset) view of a media clip. -clipartifactbookkeeping (asset) view of a media clip. clipartifacta Media Clip +clipartifactbookkeeping (asset) view of a media clip. Clipclass clipsrelation Codecclassdescription of some media data decoder or encoder facility @@ -60,8 +60,10 @@ CommonLibpackage complete Render Engineactivity object componentsrelation -CompoundClipclass +compoundclipartifactcompound of several clips (multichannel) +CompoundClipclassClip MObject which is actually a compound of several elementary clips,
e.g. the several streams found within multichannels media. CompoundMediaclasscompound of several elementary media tracks,
e.g. the individual media streams found in one media file +compoundmediaartifacta special clip as a compound of several elementary media tracks,
e.g. the individual media streams found in one media file ConditionclassI provided a reworked Condition class in my cinelerra2 repository Configclass configureoperation @@ -73,8 +75,8 @@ connectopaque activity action Constraintclass Controllercomponent -controllerpackagesourcecode package

The Processing and Render Controller,
located within the MObject Subsystem Controllerpackage +controllerpackagesourcecode package

The Processing and Render Controller,
located within the MObject Subsystem Controller Entitiesclass diagram Controller Workingsclass view ControllerFacadeclassProvides unified access to the Proc-Subsystem Controller. Especially, this Facade class provides the functions to get a render engine to carry out actual renderings. @@ -82,6 +84,7 @@ ControllerFacadecomponent create ProcNodeopaque activity action createClipoperationcreate a (possibly compound) Clip refering to this media, ready to be added to the EDL. +currEDLoperationThe EDL currently in focus. In most cases, Session and EDL are almost the same, just EDL emphasizes the collection aspect. But generally (for larger editing projects) one Session can contain several EDLs, which may even be nested. At any given time, only one of these EDLs has focus and recieves the editing commands. currFramerelation diff --git a/doc/devel/uml/index_69.html b/doc/devel/uml/index_69.html index 0c7bddcba..20380e20a 100644 --- a/doc/devel/uml/index_69.html +++ b/doc/devel/uml/index_69.html @@ -18,14 +18,14 @@ - + - + diff --git a/doc/devel/uml/index_70.html b/doc/devel/uml/index_70.html index 14b9fb500..242d89493 100644 --- a/doc/devel/uml/index_70.html +++ b/doc/devel/uml/index_70.html @@ -32,9 +32,9 @@ - - + + diff --git a/doc/devel/uml/index_71.html b/doc/devel/uml/index_71.html index 84b5e66ce..23b81058d 100644 --- a/doc/devel/uml/index_71.html +++ b/doc/devel/uml/index_71.html @@ -35,6 +35,7 @@ + diff --git a/doc/devel/uml/index_73.html b/doc/devel/uml/index_73.html index 6bb5ea25f..496421c53 100644 --- a/doc/devel/uml/index_73.html +++ b/doc/devel/uml/index_73.html @@ -20,9 +20,9 @@ - + diff --git a/doc/devel/uml/index_77.html b/doc/devel/uml/index_77.html index dac7b6a5a..997d703b9 100644 --- a/doc/devel/uml/index_77.html +++ b/doc/devel/uml/index_77.html @@ -26,13 +26,14 @@ + - + diff --git a/doc/devel/uml/index_79.html b/doc/devel/uml/index_79.html index 4902abfdc..b34c12000 100644 --- a/doc/devel/uml/index_79.html +++ b/doc/devel/uml/index_79.html @@ -19,8 +19,8 @@ - + diff --git a/doc/devel/uml/index_80.html b/doc/devel/uml/index_80.html index 2380ad9ce..d7038cb97 100644 --- a/doc/devel/uml/index_80.html +++ b/doc/devel/uml/index_80.html @@ -52,7 +52,8 @@ - + + diff --git a/doc/devel/uml/index_82.html b/doc/devel/uml/index_82.html index 5eb845aba..db5b9dc39 100644 --- a/doc/devel/uml/index_82.html +++ b/doc/devel/uml/index_82.html @@ -22,8 +22,8 @@ - + diff --git a/doc/devel/uml/index_83.html b/doc/devel/uml/index_83.html index 15423df50..c3a049c32 100644 --- a/doc/devel/uml/index_83.html +++ b/doc/devel/uml/index_83.html @@ -29,19 +29,22 @@ - + - + + + - + + - + diff --git a/doc/devel/uml/index_84.html b/doc/devel/uml/index_84.html index b86c2c7b0..686d34aef 100644 --- a/doc/devel/uml/index_84.html +++ b/doc/devel/uml/index_84.html @@ -32,18 +32,18 @@ - + - - - + + + diff --git a/doc/devel/uml/index_86.html b/doc/devel/uml/index_86.html index 1a10d10b0..ce992fef4 100644 --- a/doc/devel/uml/index_86.html +++ b/doc/devel/uml/index_86.html @@ -20,23 +20,23 @@ - + + - - + - + + - - +
NameKindDescription
edlartifactthe (high level) Edit Decision List within the current Session
EDLclass
EDLcomponent
EDLclass
EDL Example1object diagramA 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 Example2object diagramMore 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
edlsrelation
EffectclassEffect or media processing component
effectartifactEffect or media processing component
effectartifactEDL representation of a pluggable and automatable effect.
effectartifactEffect or media processing component
Effectclass
elementsrelationrelevant MObjects comprising this segment. TODO: actually necessary??
enableoperationchange the enabled status of this asset. Note the corresponding #isActive predicate may depend on the enablement status of parent assets as well
fixedplacementartifact
Fixtureactivity object
fixtureartifactthe (low level) representation of the EDL with concrete placement data
fixturerelation
Fixtureclass
Fixturecomponent
Fixtureclass
fixturerelation
fork activity nodefork activity node
FrameclassFrames are just a low level lump of continous memory, most parts are opaque. Frames are memory sensitive, they will be small constant sized structures which can be efficently managed in a pool.
Framenode
getAutomationoperation
getConnectionoperationTODO
getDependantoperationAll the other assets requiring this asset to be functional. For example, all the clips depending on a given media file. May be empty. The dependency relation is transitive.
getFixtureoperationWhile the session can be comprised of several EDLs,
there is only one Fixture, which represents the actual
configuration of all Objects to be rendered
getFrameoperationmode = READ, WRITE, ...
getIDoperation
getParentsoperationList of entities this asset depends on or requires to be functional. May be empty. The head of this list can be considered the primary prerequisite
idattributeAsset primary key.
In Memory Databaseclass diagram
inFixtureactivity action pin
inputclass instance
inputclass instance
inputclass instance
inputclass instance
instanceoperation
instructionsrelation
Interfaceclass view
mediaartifactkey abstraction: media-like assets
Media Accesscomponent
Media-Asset Relationsclass diagram
mediaaccessfacadeartifactfunctions for querying media file and channels.
MediaAccessFacadeclassprovides functions for querying (opening) a media file, detecting the channels or streams found within this file, etc. Delegating to the actual backend functions
MediaFactorycomponent
MediaFactoryclassspecialized Asset Factory for configuring (new) media asset instances based on existing media files on disk; can create placeholder assets as well
merge activity nodemerge activity node
Metaclasskey abstraction: metadata and organisational asset
metaartifactkey abstraction: metadata and organisational asset
metaartifactabstract base class of all MObjects representing meta data or processing instructions
metaartifactkey abstraction: metadata and organisational asset
Metaclass
mobjectartifactKey Abstraction: A Media Object in the Session
mobjectpackagesourcecode package

MObject Subsystem
including the Session (EDL), Builder and Processing Controller
NameKindDescription
offsetattributeOffset the actual position by this (time) value relative to the anchor point. TODO: Representation?
orgattributeorigin or authorship id. Can be a project abbreviation, a package id or just the authors nickname or UID. This allows for the compnent name to be more generic (e.g. "blur"). Default for all assets provided by the core cinelerra-3 codebase is "cin3".
ouputclass instance
ouputclass instance
ouputclass instance
ouputclass instance
OutPortclassstructural asset corresponding to some port generating media output
outportartifactstructural asset corresponding to some port generating media output
ProcNodecomponent
ProcNodeclassKey abstraction of the Render Engine: A Data processing Node
procnodeartifactKey abstraction of the Render Engine: a Processing Node
ProcPattclass
ProcPattclassspecial type of structural Asset representing information how to build some part of the render engine's processing nodes network.
procpattartifacttemplate for building some render processing network
ProjectorclassSpecial video processing node used to scale and translate image data.
projectorartifactvideo ProcNode for scaling and translating image data
providerrelation
registryrelation@internal Table or DB holding all registered asset instances.
relativeplacementartifactPlacement implemnetaion providing various ways of attaching a MObject to another one
RelativePlacementclass
RelTypeclassthe possible kinds of RelativePlacements
relTypeattributethe kind of relation denoted by this Placement
RelTypeclassthe possible kinds of RelativePlacements
removeoperationremove the given asset <i>together with all its dependants</i> from the internal DB
Render Entitiesclass diagram
Render Requestactivity parameter
segmentsrelationthe partitioning of the Timeline to be created by this tool.
Service Componentsclass view
Sessioncomponent
sessionartifactholds the complete session to be edited by the user
sessionartifactInterface: the session edited by the user
sessionpackagesourcecode package

Everything concerning the EDL and Session, within the MObject Subsystem
Sessionclass view
Sessionclass
SessionclassPrimary Interface for all editing tasks.
The session contains defaults, all the assets being edited, and a set of EDL with the individual MObjects to be manipulated and rendered.
Session structureclass diagram
sessionimplartifactholds the complete session data to be edited by the user
SessionImplclassImplementation class for the Session interface
setup Build Paramsopaque activity action
setup StateProxyopaque activity action
shortDescattributeuser visible Name-ID. To be localized.
SimpleClipclass
simpleclipartifactElementary clip (single media stream only)
SimpleClipclassElementary clip consisting of only one media stream
SmartPointerclass
SmartPointersclass view
sourcerelationthe media source this clip referes to
sourcerelationmedia source of this clip
sourcerelationthe media source this clip referes to
SourceclassSource Node: represents a media source to pull data from.
sourceartifactRepresentation of a Media source
Source Overviewdeployment diagram
toolfactoryartifactsupply of Tool implementations for the Builder
Trackclassstructural asset holding the configuration of a track in the EDL
trackattribute
trackartifactstructural asset holding the configuration of a track in the EDL
trackartifactdescriptor for one track in the Session
trackartifactstructural asset holding the configuration of a track in the EDL
Trackclass
tracksrelationelementary media assets comprising this compound
tracksrelation
tracksrelation
Trafoclass
trafoartifacttransforming processing Node
treatoperation
treatoperation
treatoperation
treatoperation
treatoperation
treatoperation
treatoperation
treatoperation
treatoperation
treatoperation
versionattributeversion number of the thing or concept represented by this asset. Of each unique tuple (name, category, org) there will be only one version in the whole system. Version 0 is reserved for internal purposes. Versions are considered to be ordered, and any higher version is supposed to be fully backwards compatible to all previous versions.
VFrameclass
vframeartifacta buffer and render process holding a Video frame
vid1class instance
vid1class instance
vid1class instance
vid_Aclass instance
vid_Aclass instance
vid_aclass instance
vid_Aclass instance
vid_aclass instance
vid_Aclass instance
videoclass instance
videoclass instance
videoclass instance
videoclass instance
videoclass instance
video1class instance
video1class instance
video1class instance
video1class instance
video1class instance
video1class instance
video1class instance
video1class instance
video1class instance
VRenderclassRepresentation of a Video render process. (Encapsulates the video buffers for the actual calculations)
vrenderartifactRepresentation of a Video render process
diff --git a/doc/devel/uml/public_operations.html b/doc/devel/uml/public_operations.html index 728368c81..ed11e213b 100644 --- a/doc/devel/uml/public_operations.html +++ b/doc/devel/uml/public_operations.html @@ -23,6 +23,7 @@ buildProcessorPathManager configureToolFactory createClipMediacreate a (possibly compound) Clip refering to this media, ready to be added to the EDL. +currEDLSessionThe EDL currently in focus. In most cases, Session and EDL are almost the same, just EDL emphasizes the collection aspect. But generally (for larger editing projects) one Session can contain several EDLs, which may even be nested. At any given time, only one of these EDLs has focus and recieves the editing commands. enableAssetchange the enabled status of this asset. Note the corresponding #isActive predicate may depend on the enablement status of parent assets as well getAppconfigaccess the configuation value for a given key.
@return empty string for unknown keys, else the corresponding configuration value get_reprAllocation @@ -30,6 +31,7 @@ getAutomationFixture getConnectionConManagerTODO getDependantAssetAll the other assets requiring this asset to be functional. For example, all the clips depending on a given media file. May be empty. The dependency relation is transitive. +getFixtureSessionWhile the session can be comprised of several EDLs,
there is only one Fixture, which represents the actual
configuration of all Objects to be rendered getFrameFilemode = READ, WRITE, ... getIDAssetManager getParentsAssetList of entities this asset depends on or requires to be functional. May be empty. The head of this list can be considered the primary prerequisite diff --git a/src/common/time.hpp b/src/common/time.hpp index 3b8db7cfb..e434d27ed 100644 --- a/src/common/time.hpp +++ b/src/common/time.hpp @@ -33,10 +33,18 @@ namespace cinelerra /** * denotes a temporal position (time point), based on timeline start. * - * investigate posix.4 realtime timers, wrap these here + * @todo currently (9/07) this is a dummy implementation to find out + * what interface the Proc layer needs. Cehteh has already written + * elaborate timehandling functions in the backend and the goal + * is for class Time to be just a thin wrapper! */ class Time - {}; + { + int dummy; + public: + Time(int dum=0) : dummy(dum) {} + operator int () { return dummy; } + }; } // namespace cinelerra #endif diff --git a/src/common/util.hpp b/src/common/util.hpp index 0b8d03e56..3d74d4ed8 100644 --- a/src/common/util.hpp +++ b/src/common/util.hpp @@ -98,7 +98,7 @@ namespace util inline bool contains (SEQ& cont, typename SEQ::value_type& val) { - SEQ::iterator end = cont.end(); + typename SEQ::iterator end = cont.end(); return end != std::find(cont.begin(),end, val); } diff --git a/src/proc/asset/media.hpp b/src/proc/asset/media.hpp index d5593c514..8349e1d69 100644 --- a/src/proc/asset/media.hpp +++ b/src/proc/asset/media.hpp @@ -40,7 +40,7 @@ -class mobject::session::Clip; +namespace mobject { namespace session { class Clip; }} namespace asset { @@ -48,6 +48,7 @@ namespace asset class Clip; class Media; class MediaFactory; + class ProcPatt; template<> diff --git a/src/proc/mobject/mobject.hpp b/src/proc/mobject/mobject.hpp index 02a3345bc..a91dbe179 100644 --- a/src/proc/mobject/mobject.hpp +++ b/src/proc/mobject/mobject.hpp @@ -25,12 +25,14 @@ #define MOBJECT_MOBJECT_H #include +#include #include "cinelerra.h" #include "proc/mobject/buildable.hpp" using std::list; +using std::tr1::shared_ptr; namespace mobject @@ -56,6 +58,9 @@ namespace mobject list placement; }; + + + typedef shared_ptr PMO; diff --git a/src/proc/mobject/placement.hpp b/src/proc/mobject/placement.hpp index c486c9573..726379ffb 100644 --- a/src/proc/mobject/placement.hpp +++ b/src/proc/mobject/placement.hpp @@ -24,6 +24,8 @@ #ifndef MOBJECT_PLACEMENT_H #define MOBJECT_PLACEMENT_H +#include "common/time.hpp" +#include "common/factory.hpp" #include "proc/mobject/mobject.hpp" #include "proc/mobject/session/track.hpp" @@ -32,7 +34,9 @@ namespace mobject { + class Placement; class ExplicitPlacement; + class PlacementFactory; class Placement @@ -45,10 +49,44 @@ namespace mobject public: + /** + * styles of placement. + */ + enum Style + { + FIXED, + RELATIVE + }; + + static PlacementFactory create; + /** resolve the network of placement and * provide the resulting (explicit) placement. */ ExplicitPlacement& resolve () ; + + protected: + Placement (); + friend class PlacementFactory; + }; + + + typedef shared_ptr PPla; + + + + + /** + * Factory specialized for creating Media Asset objects. + */ + class PlacementFactory : public cinelerra::Factory + { + public: + typedef shared_ptr PType; + typedef cinelerra::Time Time; + + PType operator() (Placement::Style, Time, PMO subject); + }; diff --git a/src/proc/mobject/session/session.cpp b/src/proc/mobject/session/session.cpp index 1bb585d3e..e926c72ad 100644 --- a/src/proc/mobject/session/session.cpp +++ b/src/proc/mobject/session/session.cpp @@ -25,12 +25,29 @@ #include "proc/mobject/session/edl.hpp" #include "proc/mobject/session/fixture.hpp" + +using cinelerra::Singleton; + namespace mobject { namespace session { - /** */ + /** @return the system-wide current session. + * Implemented as singleton. + */ + Singleton Session::getCurrent; + + + + /** create a new empty session with default values. + */ + Session::Session () + : edl(), + fixture() + { + + } diff --git a/src/proc/mobject/session/session.hpp b/src/proc/mobject/session/session.hpp index e63730eb0..f17ea1b00 100644 --- a/src/proc/mobject/session/session.hpp +++ b/src/proc/mobject/session/session.hpp @@ -24,6 +24,11 @@ #ifndef MOBJECT_SESSION_SESSION_H #define MOBJECT_SESSION_SESSION_H +#include "common/singleton.hpp" +#include "proc/mobject/placement.hpp" + +#include + namespace mobject @@ -41,12 +46,30 @@ namespace mobject * perspective, it is a collection of Media Objects * (--> MObject) placed (--> Placement) onto virtual * Tracks. + * + * Opening a Session has effectively global consequences, + * because the Session defines the available Assets, and some + * kinds of Assets define default behaviour. Thus, access to + * the Session is similar to a Singleton instance. + * */ - class Session + class Session : private boost::noncopyable { protected: - EDL& edl; - Fixture& fixture; + vector edls; + Fixture fixture; + + Session (); + friend class cinelerra::singleton::StaticCreate; //TODO use PImpl or just covariance?? + + public: + static cinelerra::Singleton getCurrent; + + void add (PPla placement); + + + EDL& currEDL () { return edl; } + Fixture& getFixture () { return fixture; } }; diff --git a/src/proc/mobject/session/sessionimpl.cpp b/src/proc/mobject/session/sessionimpl.cpp new file mode 100644 index 000000000..d8a946002 --- /dev/null +++ b/src/proc/mobject/session/sessionimpl.cpp @@ -0,0 +1,40 @@ +/* + SessionImpl - holds the complete session data to be edited by the user + + Copyright (C) CinelerraCV + 2007, Christian Thaeter + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License as + published by the Free Software Foundation; either version 2 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + +* *****************************************************/ + + +#include "proc/mobject/session/sessionimpl.hpp" +#include "proc/mobject/session/edl.hpp" +#include "proc/mobject/session/fixture.hpp" + +namespace mobject + { + + namespace session + { + + /** */ + + + + } // namespace mobject::session + +} // namespace mobject diff --git a/src/proc/mobject/session/sessionimpl.hpp b/src/proc/mobject/session/sessionimpl.hpp new file mode 100644 index 000000000..5f4aedb1c --- /dev/null +++ b/src/proc/mobject/session/sessionimpl.hpp @@ -0,0 +1,65 @@ +/* + SESSIONIMPL.hpp - holds the complete session data to be edited by the user + + Copyright (C) CinelerraCV + 2007, Christian Thaeter + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License as + published by the Free Software Foundation; either version 2 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + +*/ + + +#ifndef MOBJECT_SESSION_SESSIONIMPL_H +#define MOBJECT_SESSION_SESSIONIMPL_H + +#include "proc/mobject/session/session.hpp" +#include "proc/mobject/session/edl.hpp" +#include "proc/mobject/session/fixture.hpp" + +#include + +using std::vector; + + + +namespace mobject + { + namespace session + { + + + /** + * Implementation class for the Session interface + */ + class SessionImpl : public mobject::Session + { + protected: + vector edls; + Fixture fixture; + + SessionImpl (); + friend class cinelerra::singleton::StaticCreate; + + void add (PPla placement); + + EDL& currEDL () { return edl; } + Fixture& getFixture () { return fixture; } + + }; + + } // namespace mobject::session + +} // namespace mobject +#endif diff --git a/tests/components/proc/mobject/session/addcliptest.cpp b/tests/components/proc/mobject/session/addcliptest.cpp index 610e37445..6d2d0c7f0 100644 --- a/tests/components/proc/mobject/session/addcliptest.cpp +++ b/tests/components/proc/mobject/session/addcliptest.cpp @@ -24,12 +24,14 @@ #include "common/test/run.hpp" #include "proc/mobject/session/session.hpp" #include "proc/mobject/session/testclip.hpp" +#include "proc/mobject/placement.hpp" #include "common/util.hpp" //#include #include //using boost::format; +using cinelerra::Time; using util::contains; using std::string; using std::cout; @@ -56,7 +58,7 @@ namespace mobject { Session& sess = Session::getCurrent(); PMO clip = TestClip::create(); - PPla pla = Placement::create(FIXED, Time(1), clip); + PPla pla = Placement::create(Placement::FIXED, Time(1), clip); sess.add (pla); ASSERT (contains (sess.getEDL(), pla)); diff --git a/tests/components/proc/mobject/session/testclip.hpp b/tests/components/proc/mobject/session/testclip.hpp index f9edae2a5..3128a623d 100644 --- a/tests/components/proc/mobject/session/testclip.hpp +++ b/tests/components/proc/mobject/session/testclip.hpp @@ -26,12 +26,13 @@ #include "common/test/run.hpp" -//#include "common/factory.hpp" +#include "common/factory.hpp" //#include "common/util.hpp" //#include #include +using std::tr1::shared_ptr; //using boost::format; using std::string; using std::cout; diff --git a/uml/cinelerra3/128133.diagram b/uml/cinelerra3/128133.diagram index 037598822..e37cd05e9 100644 --- a/uml/cinelerra3/128133.diagram +++ b/uml/cinelerra3/128133.diagram @@ -1,8 +1,8 @@ format 40 -classcanvas 128005 class_ref 128005 // Session +classcanvas 128005 class_ref 128005 // SessionImpl draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default - xyz 30 608 2000 + xyz 19 606 2000 end classcanvas 128133 class_ref 128133 // EDL draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default @@ -38,7 +38,7 @@ classcanvas 131461 class_ref 128901 // Clip end classcanvas 131717 class_ref 129029 // Effect draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default - xyz 336 361 2000 + xyz 332 361 2000 end classcanvas 131973 class_ref 129157 // Meta draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default @@ -92,10 +92,14 @@ classcanvas 138629 class_ref 135173 // Segment end classcanvas 139013 class_ref 138629 // CompoundClip draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default - xyz 266 466 2000 + xyz 272 466 2000 end -relationcanvas 128389 relation_ref 128005 // - from ref 128005 z 1999 stereotype "<>" xyz 139 626 3000 to ref 128133 +classcanvas 139269 class_ref 139653 // Session + draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default + xyz 23 458 2000 + end +relationcanvas 128389 relation_ref 128005 // + from ref 128005 z 1999 to ref 128133 role_a_pos 201 603 3000 no_role_b multiplicity_a_pos 205 636 3000 no_multiplicity_b relationcanvas 128517 relation_ref 128133 // @@ -210,4 +214,8 @@ relationcanvas 139141 relation_ref 140805 // from ref 139013 z 1999 to ref 131461 no_role_a no_role_b no_multiplicity_a no_multiplicity_b +relationcanvas 139525 relation_ref 142725 // + from ref 128005 z 1999 stereotype "<>" xyz 57 558 3000 to ref 139269 + no_role_a no_role_b + no_multiplicity_a no_multiplicity_b end diff --git a/uml/cinelerra3/128261 b/uml/cinelerra3/128261 index 5addfc8e9..528bee399 100644 --- a/uml/cinelerra3/128261 +++ b/uml/cinelerra3/128261 @@ -1,6 +1,6 @@ format 40 "MObject" // ProcessingLayer::MObject - revision 20 + revision 21 modified_by 5 "hiv" // class settings //class diagram settings @@ -48,7 +48,55 @@ format 40 size A4 end - class 128005 "Session" + class 139653 "Session" + abstract visibility public + cpp_decl "${comment}${template}class ${name}${inherit} + { +${members} }; +${inlines} +" + java_decl "" + idl_decl "" + explicit_switch_type "" + + comment "Primary Interface for all editing tasks. +The session contains defaults, all the assets being edited, and a set of EDL with the individual MObjects to be manipulated and rendered." + operation 133509 "currEDL" + public return_type class_ref 128133 // EDL + nparams 0 + cpp_decl " ${comment}${friend}${static}${inline}${virtual}${type} ${name} ${(}${)}${const}${volatile} ${throw}${abstract};" + cpp_def "${comment}${inline}${type} +${class}::${name} ${(}${)}${const}${volatile} ${throw}${staticnl} +{ + ${body} +} + +" + + + comment "The EDL currently in focus. In most cases, Session and EDL are almost the same, just EDL emphasizes the collection aspect. But generally (for larger editing projects) one Session can contain several EDLs, which may even be nested. At any given time, only one of these EDLs has focus and recieves the editing commands." + end + + operation 133637 "getFixture" + public explicit_return_type "Fixture&" + nparams 0 + cpp_decl " ${comment}${friend}${static}${inline}${virtual}${type} ${name} ${(}${)}${const}${volatile} ${throw}${abstract};" + cpp_def "${comment}${inline}${type} +${class}::${name} ${(}${)}${const}${volatile} ${throw}${staticnl} +{ + ${body} +} + +" + + + comment "While the session can be comprised of several EDLs, +there is only one Fixture, which represents the actual +configuration of all Objects to be rendered" + end + end + + class 128005 "SessionImpl" visibility package cpp_decl "${comment}${template}class ${name}${inherit} { @@ -59,13 +107,13 @@ ${inlines} idl_decl "" explicit_switch_type "" - classrelation 128005 // edls () - relation 128005 o--> - stereotype "list" + comment "Implementation class for the Session interface" + classrelation 128005 // edls () + relation 128005 *--> a role_name "edls" multiplicity "1..*" protected - cpp default " ${comment}${static}${mutable}${volatile}${const}${type} * ${name}${value}; + cpp default " ${comment}${static}${mutable}${volatile}${const}${stereotype}<${type}> ${name}${value}; " - classrelation_ref 128005 // edls () + classrelation_ref 128005 // edls () b multiplicity "" parent class_ref 128133 // EDL end @@ -77,6 +125,15 @@ ${inlines} classrelation_ref 128261 // fixture () b multiplicity "" parent class_ref 128261 // Fixture end + + classrelation 144645 // + relation 142725 -_-|> + stereotype "PImpl" + a public + cpp default "${type}" + classrelation_ref 144645 // + b multiplicity "" parent class_ref 139653 // Session + end end class 128133 "EDL" diff --git a/uml/cinelerra3/130181 b/uml/cinelerra3/130181 index 0bb6e6de6..2204811cd 100644 --- a/uml/cinelerra3/130181 +++ b/uml/cinelerra3/130181 @@ -1,6 +1,6 @@ format 40 "mobject" // design::codegen::proc::mobject - revision 7 + revision 8 modified_by 5 "hiv" // class settings //class diagram settings @@ -39,6 +39,45 @@ including the Session (EDL), Builder and Processing Controller" package_name_in_tab default show_context default write_horizontally default auto_label_position default draw_all_relations default shadow default draw_component_as_icon default show_component_req_prov default show_component_rea default comment "defines source files to be generated by BOUML" + artifact 138757 "session" + stereotype "source" + cpp_h "/* + ${NAME}.hpp - ${description} +@{CopyrightClaim}@{GPLHeader} +*/ + + +#ifndef ${NAMESPACE}_${NAME}_H +#define ${NAMESPACE}_${NAME}_H + +${includes} +${declarations} + + +${namespace_start} + +${definition} +${namespace_end} +#endif +" + cpp_src "/* + ${Name} - ${description} +@{CopyrightClaim}@{GPLHeader} +* *****************************************************/ + + +${includes} +${namespace_start} + + +${members} +${namespace_end}" + associated_classes + class_ref 139653 // Session + end + comment "Interface: the session edited by the user" + end + artifact 128261 "mobject" stereotype "source" cpp_h "/* diff --git a/uml/cinelerra3/130437 b/uml/cinelerra3/130437 index 734633b1d..e5790e68f 100644 --- a/uml/cinelerra3/130437 +++ b/uml/cinelerra3/130437 @@ -1,6 +1,6 @@ format 40 "session" // design::codegen::proc::mobject::session - revision 7 + revision 8 modified_by 5 "hiv" // class settings //class diagram settings @@ -38,7 +38,7 @@ Everything concerning the EDL and Session, within the MObject Subsystem" package_name_in_tab default show_context default write_horizontally default auto_label_position default draw_all_relations default shadow default draw_component_as_icon default show_component_req_prov default show_component_rea default comment "defines source files to be generated by BOUML" - artifact 128517 "session" + artifact 128517 "sessionimpl" stereotype "source" cpp_h "/* ${NAME}.hpp - ${description} @@ -72,9 +72,9 @@ ${namespace_start} ${members} ${namespace_end}" associated_classes - class_ref 128005 // Session + class_ref 128005 // SessionImpl end - comment "holds the complete session to be edited by the user" + comment "holds the complete session data to be edited by the user" end artifact 128645 "edl" diff --git a/uml/cinelerra3/5.session b/uml/cinelerra3/5.session index e2727d655..dd61f6409 100644 --- a/uml/cinelerra3/5.session +++ b/uml/cinelerra3/5.session @@ -3,7 +3,7 @@ diagrams classdiagram_ref 130309 // Asset Kinds 860 633 100 4 0 0 active classdiagram_ref 128133 // Session structure - 860 633 100 4 341 0 + 860 633 100 4 581 0 classdiagram_ref 130437 // Media-Asset Relations 860 633 100 4 0 0 classdiagram_ref 128389 // Render Entities @@ -11,10 +11,10 @@ diagrams end show_stereotypes selected -package_ref 129 // cinelerra3 + package_ref 129 // cinelerra3 open -package_ref 128005 // design + package_ref 128005 // design classview_ref 128901 // Assets classview_ref 128005 // Session classview_ref 129029 // Interface diff --git a/uml/cinelerra3/cinelerra3.prj b/uml/cinelerra3/cinelerra3.prj index cd49f3161..26a25ad00 100644 --- a/uml/cinelerra3/cinelerra3.prj +++ b/uml/cinelerra3/cinelerra3.prj @@ -1,6 +1,6 @@ format 40 "cinelerra3" - revision 29 + revision 30 modified_by 5 "hiv" cpp_root_dir "../../src/" diff --git a/wiki/renderengine.html b/wiki/renderengine.html index 9ddac1a24..90d649411 100644 --- a/wiki/renderengine.html +++ b/wiki/renderengine.html @@ -755,12 +755,18 @@ The main tool used to implement this separation is the [[Builder Pattern|http:// Another pertinent theme is to make the basic building blocks simpler, while on the other hand gaining much more flexibility for combining these building blocks. For example we try to unfold any "internal-multi" effects into separate instances (e.g. the possibility of having an arbitrary number of single masks at any point of the pipeline instead of having one special masking facility encompassing multiple sub-masks. Similarly, we treat the Objects in the EDL in a more uniform manner and gain the possibility to [[place|Placement]] them in various ways.
-
+
''EDL'' is a short-hand for __E__dit __D__ecision __L__ist. The use of this term can be confusing; for the usual meaning see the definition in [[Wikipedia|http://en.wikipedia.org/wiki/Edit_decision_list]]
 
 Cinelerra uses this term in a related manner but with a somewhat shifted focus (and we just stick to this usage here): In Cinelerra the EDL is comprised of the whole set of clips and other media objects parametrized and placed onto the tracks by the user. It is the result of the user's //editing efforts.//
 
-In this usage, the EDL is almost synonymous to the ''Session'', just the latter emphasizes more the state aspect, as it can be thought as a current state of the EDL contained in a file or data structure together with additional Option values and settings for the GUI. The Session is what you save and load, while the EDL rather denotes a structure of Objects placed in time.
+In this usage, the EDL in most cases will be almost synonymous to the ''Session'', just the latter emphasizes more the state aspect, as it can be thought as the current EDL contents contained in a file or data structure together with additional Option values and settings for the GUI. The Session is what you save and load, while the EDL rather denotes a structured collection of Objects placed in time.
+
+!!!larger projects
+For larger editing projects the simple structure of a session containing "the" timeline is not sufficient. Rather, we have several timelines, e.g. one for each scene. Or we could have several layered or nested timelines (compositional work, multimedia productions). To support these cases without making the default case more complicated, Cinelerra-3 introduces a //focus// for selecting the //current EDL,// which will receive all editing operations.
+
+!!!the definitive state
+With all the structural complexities possible within such a session, we need an isolation layer to provide __one__ definitive state where all configuration has been made explicit. Thus the session manages one special object list, the [[Fixture]], which can be seen as all currently active object placed onto a single timeline.
@@ -881,13 +887,14 @@ Some further details * and, as the created smart-pointer is a template parameter, such a custom Functor can create all sorts of Proxies, wrappers and the like
-
+
a specially configured EDL
  * all MObjects have their position, length and configuration set up ready for rendering.
- * all MObjects are associated with a ExplicitPlacement
+ * compound objects (e.g. multichannel clips) have been resolved to single non-compound basic objects.
+ * every MObject is associated with an ExplicitPlacement, which declares a fixed position (Time, Track)
  * this ~ExplicitPlacements are contained in a ordered List called the Timeline
 
-//My intention is to create this Fixture out of the editing operations done by the user//
+As the builder and thus render engine //only consults the fixture,// while all editing operations finally propagate to the fixture as well, we get an isolation layer between the high level part of the Proc layer (editing, object manipulation) and the render engine