Logical architecture / design of OpenShot

Asked by Michael Wolff-Polaszyk

Hi,

is there any document, that describes the logical design of Openshot?

Writing a blueprint or something else it would be nice, if I could
use abreviations and associated definitions, so that there is a common
'language' (where it's possible).

Technically Openshot uses python, gtk (for the UI) and mlt etc. But I'm
not a good coder, so this is beyond my possibilities to dig that in deep.

First there's the Instruction Manual, but it describes not the future
the user will see. There are some discriptions, but not in deep and
that's ok.

May be I am missing a index with definitions, some examples:

Clip - video, image (still, sequence), audio in various formats
Clip in pool - CiP
Clip attached to a track - CaT

Effect - (up to now) transforming the CaT (picture or audio) with
different filters(?)
Effect attached to a track, layer, clip - today is it attached to a clip,
other things are on the wishlist

Transitions - special effect concerning (minimum 2 - today only 2) CaT
at neighbouring tracks; or is it a special Track, up to now without
any editing abilities?

Filter - procedures(-plugins ?) for video (f.e. grouped by transformation,
interlacing, (de)noising, sharpness/blur etc.) and audio (highpass,
lowpass, resampling etc.), I think a different word for effect,

Using a plugin-system would be very nice for quality issues (I refer to
those UI in avidemux or wax), so that I could do most things without
different apps. is this technically created with the frei0r-plugins?

Sub-Track - Layers of a Track, containing different Effects in
chronological orders (not yet implemented). Up to now there is
a representation of the actual object/implamentation - I guess.

but there are also some actions

import - to a pool, track and ...
export - part / whole timeline
moving (a group of CaT and other to CaT attached objects)
insert in one Track or effective to all Tracks / Layers
cut a clip OR all clips at a given marker / timeline cursor position

etc. etc.

Would this be usefull for developers, supporters, bugtrackers?

If I could support the team in this way, I'll try

OpenShot is really a userfriendly entrance and very useful to me
leaving the windows world for privat purpose.
Keep on moving

Kind regards
Michel

Question information

Language:
English Edit question
Status:
Solved
For:
OpenShot Video Editor Edit question
Assignee:
No assignee Edit question
Solved by:
Michael Wolff-Polaszyk
Solved:
Last query:
Last reply:
Revision history for this message
Jonathan Thomas (jonoomph) said :
#1

There is no technical design document, so to speak. Although, I've never quite thought of it so black and white before. =) There is a lot of documentation on how OpenShot works, but not in a condensed form, with simple diagrams, definitions, etc... I really like this idea.

I'm not sure if this can be added as a blueprint in LaunchPad, as that system has very few formatting options, etc... It might be better if we created some topics in our help manual, which is stored as an ODT file. Possibly a new section called OpenShot Architecture or OpenShot Design. You can get the ODT at:
https://code.launchpad.net/~jonoomph/openshot/openshot-docs

Also, it's worth noting, that the ODT uses a set of styles and exports to the DocBook XML format, which is used to generate all the different versions, such as HTML, Yelp, PDF, etc...

Thanks!
-Jonathan

Revision history for this message
Olivier Girard (eolinwen) said :
#2

If I could support the team in this way, I'll try

And you could help us on several ways for example here, on our forums, etc.........
Anyway, Thanks.

Revision history for this message
Michael Wolff-Polaszyk (micoganic) said :
#3

Hi you all,

thanks for your replies. I was a little time absend and my holidays are now finished.
Though I will download the document with bazar and have a look at it. I start with this
a Wednesday next week.

Have nice day

Bye
Michael Wolff-Polaszyk aka micoganic