Commit graph

627 commits

Author SHA1 Message Date
15214cc069 WIP start stubbing and defining time quantisation and timecode entities 2011-01-13 03:36:08 +01:00
f2c18e5a9c RfC describing necessary steps for installing and packaging Lumiera 2011-01-11 17:17:27 +01:00
21118d4831 Add a note about Python pretty printers in GDB 2011-01-07 18:03:26 +01:00
Stefan Kangas
96c1192747 spelling fixes 2010-12-28 02:21:36 +01:00
c1be39eacb Merge recent time quantisation analysis
Merge branch 'timequant' into proc
2010-12-26 22:30:28 +01:00
Stefan Kangas
bdb9832f29 Rename "Resources" to "Assets" 2010-12-26 22:30:07 +01:00
1294926508 Time Quantisation: theoretical analysis and initial design draft 2010-12-20 07:37:41 +01:00
e1708f33b9 Merge testsuite and builder changes from Lumiera master 2010-12-18 02:30:02 +01:00
4410830f72 Merge Fixture datastructure and Testsuite work 2010-12-17 22:51:27 +01:00
ef95048de0 formatting fixes for existing RfCs 2010-12-13 04:46:44 +01:00
1ce29b7d3c minor tweaks to the RfC system
- add 'asciidoc' operation to rfc.sh
- put 'pro', 'con' and 'alternatives' in a common section 'Discussion'
2010-12-13 04:46:05 +01:00
7960ab5364 Start a RfC regarding requirements of Website Navigation 2010-12-08 12:31:51 +01:00
Simon Larcher
620a22b2a8 Added anchors to the glossary. Fine tuned the wording in design/index.html
The arrows "->" before each item in the glossary give direct links.
Use the #anchor of the link to refer to it.
Everything from the item name is kept with rules : Two Words = #TwoWords | Two/Words = #Two_Words
2010-12-08 01:10:38 +01:00
Stefan Kangas
c6f03f79bc Fix minor typo 2010-12-06 04:40:06 +01:00
56ceca398b The first substantial step towards a builder backbone
Defined the structure of the fixture and the outline
of the process leading to creating this data structure.
2010-12-05 02:46:36 +01:00
Simon Larcher
fd6492d745 Adapting commit; local layout different from the one of the website 2010-12-04 02:54:54 +01:00
Simon Larcher
05a0be53b1 Merge branch 'documentation' of git.lumiera.org:/var/www/git/lumiera_documentation into documentation 2010-12-04 02:48:32 +01:00
Simon Larcher
4cbdd6408e Reviewed design/index.txt Not quite happy with the links and headers yet, still needs improvements
Don't hesitate to /notice or /query me on IRC about this page, I am SvenL-
2010-12-04 02:45:22 +01:00
11c3187880 Integrate the hand written notes by Mike Provost 2010-11-28 07:32:33 +01:00
06ca9f68bd rewrap and clean up asciidoc structure (no content change) 2010-11-28 07:03:11 +01:00
bfc7e70c99 move BJMR's workflow-outline into suitable documentation directory 2010-11-28 06:35:03 +01:00
f947f4522c Merge work on OutputDesignation and OutputMapping
Merge commit 'prg@ichthyostega.de/session_signature'
2010-11-28 05:29:53 +01:00
f0fbf0e6f1 bring some UML diagrams up-to-date 2010-11-22 02:28:03 +01:00
6c0a677cbc fix some typos 2010-11-21 21:43:44 +01:00
2c322c58b5 fill a "gap" in the glossary, regarding output managment 2010-11-18 23:54:20 +01:00
a53515bf30 the_inner_core is considered rather a piece of technical documentation 2010-11-18 22:49:25 +01:00
42c26c9086 fix a link 2010-11-18 22:32:49 +01:00
Simon Larcher
885c2c9ee7 Minor changes on doc index and technical doc index
Intended to make pages more user friendly. Formatted pages structures and added text
2010-11-18 22:21:48 +01:00
4a161fb54d add backup of the original (unreviewed) GuiBrainstorming page
Somehow I can't find this original page, but according to the
comment in the source, it should have been asciidoced. I'm filing
this backup from the Pipa-Wiki (MoinMoin), because this original page
still contains a wealth of ideas, even if we won't have
the standing to cope with them right now.
2010-11-17 05:29:21 +01:00
991e78633f rearrange-, link in and fix further content (user/design docs) 2010-11-17 04:41:29 +01:00
1081e9fe8c remove generated UML report. Diagrams and TiddlyWikiy are sufficient
Up to now we commited the Bouml generated HTML report of the UML model
While the UML is still valid and will be kept up-to date in future,
meanwhile the Bouml generated diagrams (png) will be sufficient, as
being linked in and explained within the TiddlyWiki.
2010-11-17 04:41:29 +01:00
0844f05ef2 statistics & reports, linking to the Ohloh stats 2010-11-17 04:41:28 +01:00
9085de3e15 adjust overview pages and link in further content 2010-11-17 04:41:28 +01:00
414f8a066d move in and adjust some of the asciidoced design documents 2010-11-17 04:41:28 +01:00
3bd7c610fc Move in the existing documentation outline from the Website-repository 2010-11-17 04:41:28 +01:00
7bc7ae09fc Especially ignore Asciidoc generated HTML files in the documentation tree 2010-11-17 04:39:36 +01:00
58ce4b51ad added the documentation overview pages from the new website-draft 2010-11-14 03:38:43 +01:00
f485bef315 Merge documentation and RFCs 2010-10-16 02:14:21 +02:00
f9e42c53a6 comment on the RFC 'new doc structure' 2010-10-16 01:59:47 +02:00
Christian Thaeter
e476102467 RFC: new doc structure 2010-10-16 00:57:51 +02:00
Christian Thaeter
bc36b12b99 Write a bit about resource management 2010-10-16 00:57:51 +02:00
Christian Thaeter
2989e817df Some more explanations for the library and backend components 2010-10-16 00:57:50 +02:00
Christian Thaeter
7470b0567e New 'the inner core' document
Describes some of the design decisions and rationales in a rather sketchy
way explained. New Developers may find this Document useful to get an idea
about how the different components work together.
2010-10-16 00:57:50 +02:00
Christian Thaeter
12f6e48514 rewrap text to 80 colummns (except for comments) 2010-10-16 00:57:50 +02:00
ec4eabb95f went over the "outer space" draft, expanded on some points
also answered some questions inline. Please see all of this as a proposal
and feel free to merge in parts....
2010-10-16 00:57:50 +02:00
Christian Thaeter
c29f48d049 Some corrections by torwil on irc 2010-10-16 00:57:50 +02:00
Christian Thaeter
5e38dfbb01 First draft for the 'from outer space document
Some rough Text and a lot of comments/notes. Nothing if final yet.
2010-10-16 00:57:50 +02:00
Christian Thaeter
091785c2d4 Rewrap all RFC's
This reverts commit 65bae31de4103abb7d7b6fd004a8315973d3144a.
and reprocessed the wrapping.

Note that the automatic wrapping is not perfect, some manual fixing
by removing some hunks was required.
2010-08-01 03:19:24 +02:00
Christian Thaeter
6cf8b9f2f3 RFC about the application main thread handling signals and resource management 2010-08-01 03:19:23 +02:00
Christian Thaeter
86d877f1fb wrap and reformat the rfc template a bit 2010-08-01 03:19:23 +02:00
Christian Thaeter
a895e6a666 Line wrapped all rfc's 2010-08-01 03:19:23 +02:00
Christian Thaeter
32933c7c88 WIP: Draft rfc about resource budgeting 2010-08-01 03:19:23 +02:00
Christian Thaeter
bea7364b35 WIP: Draft about the profiler 2010-08-01 03:19:23 +02:00
Christian Thaeter
34f0211d7f initial processing of all RFC's it worked! 2010-08-01 03:19:23 +02:00
Christian Thaeter
d1d3461e5d Import old DesignProcess into rfc_pending 2010-08-01 03:19:23 +02:00
Christian Thaeter
64ad648eac DesignProcess is dead, long live RFC
* new directory structure in doc/devel to take RFC's
   rfc/          - Final RFC's
   rfc_pending/  - Emerging RFC's
   rfc_dropped/  - Rejected or Parked RFC's
 * Template directory doc/template/ for just a rfc.txt
   for creating new RFC's yet
 * admin/rfc.sh a script to maintain RFC's
2010-08-01 03:19:22 +02:00
Christian Thaeter
ac7d14f051 inner_core: cosmetics, vcall.h, error.h, tmpbufs 2010-08-01 03:18:12 +02:00
Christian Thaeter
3e852c9d24 inner_core: few words about coding style, tdd and documentation 2010-08-01 03:18:12 +02:00
Christian Thaeter
b868d64843 document: inner_core error handling overview 2010-08-01 03:18:12 +02:00
Christian Thaeter
9e04e87cab Write a bit about resource management 2010-08-01 03:18:12 +02:00
Christian Thaeter
39c3fe63ad Some more explanations for the library and backend components 2010-08-01 03:18:11 +02:00
Christian Thaeter
6cdec3720e New 'the inner core' document
Describes some of the design decisions and rationales in a rather sketchy
way explained. New Developers may find this Document useful to get an idea
about how the different components work together.
2010-08-01 03:18:11 +02:00
Christian Thaeter
27a610c957 rewrap text to 80 colummns (except for comments) 2010-08-01 03:18:11 +02:00
9a396c6725 went over the "outer space" draft, expanded on some points
also answered some questions inline. Please see all of this as a proposal
and feel free to merge in parts....
2010-08-01 03:18:11 +02:00
Christian Thaeter
7b1bc6115e Some corrections by torwil on irc 2010-08-01 03:18:11 +02:00
Christian Thaeter
8bbc584f3e First draft for the 'from outer space document
Some rough Text and a lot of comments/notes. Nothing if final yet.
2010-08-01 03:18:11 +02:00
Christian Thaeter
c4cbde9853 add a 'bias' to offset mmaped clusters
We will need cluster/page aligned access for certain files (indices),
this files will contain an initial header describing the contents. A bias
is used to step over this header and align the following data.
2010-07-21 04:49:40 +02:00
7895ce5f49 solve the problem with re-binding and advice::Request 2010-06-04 17:25:33 +02:00
a9595d0a7f refactor link to the advice system into separate baseclass 2010-06-03 04:40:38 +02:00
c8ac2b0447 planning the advice binding index implementation 2010-06-03 04:40:35 +02:00
1245f873e6 Advice: Requirements, design conclusions, implementation draft. 2010-06-03 04:40:34 +02:00
0f6c2e84d2 test-driven brainstorming: TypedID usage 2010-06-03 04:37:22 +02:00
ea861a8c74 update UML to reflect improved Asset/MObject design 2010-06-03 04:37:21 +02:00
cbf71e46da Planning and designing the session API 2010-06-03 04:37:12 +02:00
cdb84a9b16 refining the draft for ScopeLocator 2009-11-20 19:58:22 +01:00
572f26edc8 document the QueryResolver design 2009-10-30 17:16:37 +01:00
5968d35cdf WIP maybe resolved now the knot in my design...? 2009-10-25 21:39:02 +01:00
eb2d309601 WIP: reworked the design further 2009-10-24 16:03:14 +02:00
8345df394d WIP continued turning over the problem.... 2009-10-23 03:10:55 +02:00
90e09b9fa0 WIP trying to get ahed with the problem of issuing queries 2009-10-22 17:24:57 +02:00
007a6e1855 Consideration how to issue content discovery queries 2009-10-21 05:35:32 +02:00
a662b176bb WIP test-driven brainstorming: what is a Scope? 2009-10-17 02:15:28 +02:00
cfc17e75ba refined and clarified planning of Scope and QueryFocus 2009-10-16 21:20:30 +02:00
d193fbf920 Planning the QueryFocus in more detail 2009-10-16 01:54:38 +02:00
4695f41b7c Documentation of PlacementScope concept 2009-10-12 08:10:00 +02:00
4236d0649a WIP: implement the basic operation of execution pattern 2009-08-02 18:00:03 +02:00
eaa4adddde WIP more implementation drafting... 2009-07-29 16:55:15 +02:00
19dd606f54 WIP some implementation drafting... 2009-07-27 02:38:53 +02:00
d122a32662 Documentation & planning the parts to implement next 2009-07-21 04:13:12 +02:00
529d4bd459 Planning / Design: Session interface, Commands 2009-06-08 04:50:29 +02:00
8e46819c09 UML: export actual Version as HTML report 2009-06-08 04:49:46 +02:00
6f00eb742b regenerate all immages currently used by the renderengine TiddlyWiki 2009-06-08 04:49:25 +02:00
ea56841389 DummyPlayer finished. General Documentation regarding Layer Interfaces and DummyPlayer 2009-02-09 05:48:28 +01:00
c9f9c3d0d3 Document what happens when running the DummyPlayer 2009-02-01 17:26:25 +01:00
6473971d60 fix a typo 2009-01-31 23:42:57 +01:00
c01657b93f continued achitecture planning for the Dummy Player 2009-01-31 23:42:56 +01:00
29b9887faa first draft of a Dummy-Player service 2009-01-19 11:38:20 +01:00
ff78f9e535 concept sketch 2009-01-17 14:58:48 +01:00
Christian Thaeter
61ea2154bb Add Doxyfile.pdf
This generates very terse Documentation for hardcopies

 * All official docs are included
 * No Graphs
 * No internal, TODO, BUGS, etc. docs
 * No inlined sources
2008-12-15 01:17:23 +01:00
Christian Thaeter
67cd569d9f New Doxyfile.browse for detailed code browsing
This generates a detailed documentation in html_browse/

 * all things get extracted (undocumented, TODO, BUG etc...)
 * produces a warnings_browse.txt to show undocumented things
 * no graphs to keep it reasonable small
2008-12-15 01:17:22 +01:00
Christian Thaeter
147b371952 main Doxfile refinements
* remove TODO TEST BUG DEPRECATED lists
 * don't inline sources

The goal is to generate a more appealing and compact default Documentation
2008-12-15 01:17:22 +01:00
Christian Thaeter
065bc25eca Remove the tests dir from the normal Doxyfile
As on the nov2008 developer meeting we concluded that the normal
Documentation shall have less noise and reflect the actual project state.
Further we will introduce special Doxyfiles for special tasks.
2008-12-15 01:17:22 +01:00
Christian Thaeter
b94ede5b0b Give a overview drawing how things in the io backend relate to each other
My first inkscape drawing
2008-12-15 01:17:21 +01:00
Christian Thaeter
219db59d82 renamed backend config entries
adding one level more, more descriptive
2008-12-15 01:17:21 +01:00
Christian Thaeter
5bbe80b370 preliminary use of the config system for some settings
* backend.filehandles maximum filehandles used
 * backend.mmap_window_size mapping window start size
 * backend.as_limit address space limit

This needs to be changed to use the lumieraorg_configuration interface.
2008-12-15 01:17:21 +01:00
Christian Thaeter
e938b36071 WIP: mmap management first go
Quite some code which was hold back in favor of the config and plugin stuff
implements:

 * mmapcache: mru cache for unused memory mappings
 * mmap: single mmaped areas
 * mmapings: manages mmaps established for one filedescriptor
2008-12-15 01:17:21 +01:00
80e1e382f4 merge new plugin/interface system, testsuite changes, documentation 2008-11-07 01:26:31 +01:00
Christian Thaeter
58bcc59a90 The incomplete Guide to Lumiera Configuration
This shall become a reference of all (most) lumiera configuation keys.
So far this is only prelimary located in the doc/devel dir and will be
moved to the documentation wiki as soon as it becomes available.
2008-11-06 05:38:33 +01:00
b0b29e86a4 forgot to add some UML 2008-11-03 21:27:03 +01:00
0d1dbac28f UML drawing and further description of Timeline, Sequence, Output 2008-11-02 23:19:37 +01:00
490b7d163c doc cleanup 2008-10-20 03:33:55 +02:00
1b6df94aab documentation (drawing) 2008-10-18 04:15:07 +02:00
caf7497021 drawing to show time position of frames
used in Design Entry regarding time handling
2008-10-05 07:10:15 +02:00
07a08bb6d6 some tweaks to the Doxygen,
to improve the arrangement of the various sections within the documentation of one class
2008-09-07 20:55:14 +02:00
Christian Thaeter
b594ffb3c5 Doxyfile update
new doxwizard insisted to add some new config vars, so let it be.
2008-09-06 12:25:52 +02:00
c7c6fe547f improved the architecture overview (drawing) 2008-09-04 18:04:53 +02:00
6d5cf0e642 scons: use Doxygen builder
(lib implementation from http://www.scons.org/wiki/DoxygenBuilder)
2008-08-28 02:57:12 +02:00
c5778f1540 Merge from proc (draft imp of pull() call) 2008-08-17 18:35:49 +02:00
749f7a41c6 Landing draft implementation of pull() call 2008-08-17 04:22:46 +02:00
Joel Holdsworth
a845b625b4 Added more documentation 2008-08-16 17:41:57 +01:00
Joel Holdsworth
1532bc40e0 Added and corrected documentation 2008-08-16 16:44:52 +01:00
790deb16b6 finished the drawing, added an example session containing 2 EDLs with track tree 2008-08-15 07:05:43 +02:00
302aa08757 add to the drawing an example featuring a clip with attached effects 2008-08-12 04:07:58 +02:00
7fd70a476c add a description and my favorite Lumiera Logo 2008-08-09 19:42:22 +02:00
2625067e37 started a drawing showing the high level model structure. 2008-08-09 08:15:37 +02:00
cb5d1fd03b WIP further refactored the nodeoperation 2008-07-14 03:34:18 +02:00
7c56c71d00 Documentation Update, including info about ongoing builder work 2008-07-07 23:56:34 +02:00
9389ce2d68 WIP possible solution how the operation chunks could be assembled 2008-07-01 04:53:23 +02:00
5f39f843c3 WIP considering how to compose the actual StateProxy 2008-06-29 18:45:35 +02:00
eeb2d04dee WIP trying to translate some of the planned pull() process into code... 2008-06-14 04:19:58 +02:00
e8378485cc planning the buffer management and render mechanics more precisely 2008-06-11 05:44:10 +02:00
3c2a6f0598 planing more details of the render mechanics 2008-06-03 06:22:41 +02:00
c0d7ae1aa2 Merge added builder documentation 2008-05-27 02:11:35 +02:00
f3d078f93b add drawing to explain the builder primitives 2008-05-23 07:05:35 +02:00
85189d3f4c extend Appconfig class to provide Lifecycle callback hooks
esp. for automatic triggering the initialisation of very basic struff (like NoBug...)
2008-04-13 23:54:39 +02:00
ce72947d0c brought proc layer introductory pages up-to-date 2008-04-13 03:39:18 +02:00
f7bfe50bc9 Merge branch 'builder' 2008-04-12 02:12:41 +02:00
a03e3c5e73 Merge from backend: wikis, admin-scrits, test.sh
(dont merge any srcfiles)
2008-04-12 02:07:16 +02:00
dfefbea769 overdue to write down some documentation about ConfigRules
(starting to loose track of some relations myself...)
2008-04-07 05:11:09 +02:00
c4128c9816 merge Lumiera renaming
WIP doesn't pass the compiler (not due to the merge)
2008-03-10 08:38:59 +01:00
0baf15ca94 Cinelerra-3 renamed to Lumiera -- copyright and documentation 2008-03-10 04:25:03 +01:00
113678ff93 some refacturing of the (preliminary) struct asset impl... 2008-02-15 02:56:25 +01:00
857422f6e2 Rename 'Port' to 'Pipe' I: UML and documentation.
finally I've settled down to the name 'Pipe', because its the best description for this concept...
2008-02-14 03:34:29 +01:00
b7bce2a2f7 WIP defined lots of details regarding the handling of Ports 2008-01-12 18:19:37 +01:00
d255d68d35 reflect design decisions in UML, new track-MO class, start replacing tracknumber by Port 2008-01-07 18:16:03 +01:00
46b200809e WIP desperately trying to work out a really usable visitor implementation 2007-12-22 08:45:09 +01:00
6d4133cefe WIP generalizing my builder tools to use the acyclic visitor.
inspired by Loki; ichthyo intends to use this pattern for typesafe visiting within the EDL too...
2007-11-27 06:40:51 +01:00
49459b4bf7 Fix inheritance of asset::Unknown, fix broken test, enable MakeClip_test 2007-11-20 05:20:01 +01:00
0837cfe977 put just a summary on the ProcLayer-Wiki startpage,
and moved much of the current content to the DesignGoals page. Checked the various overview
pages to be still up-to-date...
2007-11-13 01:10:43 +01:00
c58fd16edb WIP implement some Placement implementation 2007-10-22 05:15:08 +02:00
a089e5ff15 WIP maybe nailed down the design problem regarding placements now.... 2007-10-18 17:29:01 +02:00
08f10c2a2e WIP trying to get the Placement stuff right,
but seemingly still having some design mismatch...
2007-10-13 05:13:28 +02:00
06f2503e62 clarified how to handle Placements 2007-10-10 03:54:09 +02:00
83a972f846 work out the details how to handle and access the 'current session' 2007-09-27 23:07:05 +02:00
82e9519e73 WIP specify some details of the session interface and the relation of session and EDL 2007-09-27 04:45:06 +02:00
cc3d3397a7 documented the new design in more detail 2007-09-22 16:00:36 +02:00
1b40817d56 design: processing pattern
(prereq. for further implementing the builder)
2007-09-22 02:53:03 +02:00
85a8f87245 Preliminary Design of the Asset Subsystem.
While I don't want to target this complex now, I designed some of the fundamental aspects
as far as needed to be able to add Objects to the EDL and build a render graph from them.
2007-09-02 17:51:46 +02:00
Christian Thaeter
5832cfeae2 Merge branch 'master' of git://git.pipapo.org/cinelerra3/ichthyo 2007-08-30 01:42:06 +02:00
6d9ce217bd played a bit with doxygen and tried some small tweeks... 2007-08-24 02:58:13 +02:00
Christian Thaeter
0aaaa1c368 Doxyfile tweak EXTRACT_ALL=YES
I don't know how else to turn on the docs on the C files in src/lib, maybe I have to read the Doxygen documentation once more
This generates monstrous docs! should be cleaned up somehow someday
2007-08-23 05:03:41 +02:00
Christian Thaeter
a90732403e just a little refinement to the doxyfile 2007-08-20 03:56:08 +02:00
Christian Thaeter
02f775a190 Doxyfile 1st try 2007-08-20 03:38:39 +02:00
91bddede45 better organization of global imports and namespaces
avoid spurious quasi-global namespace cinelerra and use namespace hierarchies only where necessary.
document my intended use of namespaces/interfaces in the renderengine-wiki.
2007-08-09 18:51:47 +02:00
049c5e252b class/modelling refinements 2007-08-05 04:51:55 +02:00
814a584fa1 upgraded UML-Model to BOUML 2.29-1
To help with the conversion, which will create a bunch of new object instance nodes,
I separated out the Object diagrams into a separate use case view
2007-08-03 18:40:18 +02:00
Christian Thaeter
b32425820d generated HTML 2007-06-28 03:54:17 +02:00
Christian Thaeter
81366e9822 dir info for bouml generated html 2007-06-27 02:55:23 +02:00
bfbd4c9b0a fix spelling 'Explicit' (as poited out by Plouj) 2007-06-26 08:20:31 +02:00
d64e8d31a8 switch to the backported BOUML version 2.27-2
which gives us stable image links. Note 2.28 introduces major format changes and is not
bug-free at the moment, so I rather backported only the needed functionallity
2007-06-25 09:02:09 +02:00
5b1858bc1b Merge commit 'pipapo' 2007-06-22 09:09:14 +02:00
63fc549f8a added definition tiddlers for many terms used in my design 2007-06-22 08:46:15 +02:00
Christian Thaeter
9c4054b20c few more DIR_INFO's 2007-06-22 04:14:14 +02:00
4e2612576d renamed UML project to 'cinelerra3', re-genrated html doc. 2007-06-21 03:14:40 +02:00
18428f2000 better use doc/devel/uml... 2007-06-21 02:57:49 +02:00
b7b0ea199e start putting files to the final locations: move generated uml-html doc... 2007-06-21 02:55:50 +02:00
Christian Thaeter
74b8f74f3c add dirs with DIR_INFO files describing intended content 2007-06-18 02:02:16 +02:00