benn/lumiera_documentation
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Sync documentation with current master tree

Browse source
This commit is contained in:
Fischlurch 2011-09-25 19:22:18 +02:00
commit 5355732367
24 changed files with 63 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README
View file

@ -66,8 +66,8 @@ or the local Copy of this page in the file INSTALL
Debian Package
--------------
[verse]
Hermann Vosseler (aka Ichthyo) maintains a *Debian* packaging of the source tree,
which can be pulled from +git://git.lumiera.org/lumiera/debian+
It can be built by +git-buildpackage+
Hermann Vosseler (aka Ichthyo) maintains a *Debian* packaging of the source tree
- the package definition can be pulled from +git://git.lumiera.org/lumiera/debian+
- the package can be built by +git-buildpackage+

2
SConstruct
View file

@ -350,7 +350,7 @@ def defineBuildTargets(env, artifacts):
artifacts['config'] = ( env.ConfigData(env.path.srcConf+'setup.ini', targetDir='$ORIGIN')
+ env.ConfigData(env.path.srcConf+'dummy_lumiera.ini')
)
artifacts['lumiera'] = ( env.Program('lumiera', ['src/lumiera/main.cpp'], LIBS=core, install=True)
artifacts['lumiera'] = ( env.Program('lumiera', ['src/lumiera/main.cpp'] + core, install=True)
+ artifacts['config']
)

2
doc/devel/report.txt
View file

@ -1,7 +1,7 @@
Statistics and Reports
======================
//Menu: label Statisticts
//Menu: label Statistics
++++++++++++++++++++++++++++++++++++++

2
src/backend/Makefile.am
View file

@ -31,7 +31,7 @@ liblumierabackend_la_SOURCES = \
$(liblumierabackend_la_srcdir)/filehandle.c \
$(liblumierabackend_la_srcdir)/filehandlecache.c \
$(liblumierabackend_la_srcdir)/fileheader.c \
$(liblumierabackend_la_srcdir)/mediaaccessfacade.cpp \
$(liblumierabackend_la_srcdir)/media-access-facade.cpp \
$(liblumierabackend_la_srcdir)/mmap.c \
$(liblumierabackend_la_srcdir)/mmapcache.c \
$(liblumierabackend_la_srcdir)/mmapings.c \

5
src/backend/backend.c
View file

@ -102,7 +102,8 @@ lumiera_backend_init (void)
lumiera_backend_pagesize = sysconf(_SC_PAGESIZE);
TODO ("add config options to override following defaults");
/////////////////////////////////////////////////////////////////////TICKET #838 add config options to override following defaults"
const char* filehandles = lumiera_tmpbuf_snprintf (SIZE_MAX,
"backend.file.max_handles = %d",
@ -168,7 +169,7 @@ lumiera_backend_mpool_purge (enum lumiera_resource_try itr, void* data, void* co
(void) context;
(void) data;
(void) itr;
TODO("mpool_purge ((MPool) data)");
///////////////////////////////////////////////////////////TICKET #837 actually implement mpool purging
return LUMIERA_RESOURCE_NONE;
}

9
src/backend/threadpool.c
View file

@ -76,8 +76,9 @@ lumiera_threadpool_destroy(void)
{
LUMIERA_CONDITION_SECTION (cond_sync, &threadpool.pool[i].sync)
{
TODO ("check threads deadlines, kill them when they are stalled");
TODO ("for threads without deadline use a timeout from config system, 500ms or so by default");
//////////////////////////////////////////TICKET #843 check threads deadlines, kill them when they are stalled"
//////////////////////////////////////////TICKET #843 for threads without deadline use a timeout from config system, 500ms or so by default
LUMIERA_CONDITION_WAIT(llist_is_empty (&threadpool.pool[i].working_list));
}
}
@ -136,7 +137,9 @@ lumiera_threadpool_acquire_thread (enum lumiera_thread_class kind,
llist_insert_head (&threadpool.pool[kind].working_list, &ret->node);
ENSURE (ret, "did not create a valid thread");
TODO ("no error handing, let the resourcecollector do it, no need when returning the thread");
//////////////////////////////////////////////////////////////////////TICKET #844 no error must be pending here
//////////////////////////////////////////////////////////////////////TICKET #844 let the resourcecollector do it, no need when returning the thread
LUMIERA_CONDITION_WAIT (!llist_is_empty (&threadpool.pool[kind].idle_list));
}
// use an existing thread, pick the first one

4
src/backend/threads.c
View file

@ -120,7 +120,7 @@ thread_loop (void* thread)
INFO (threads, "Thread Shutdown");
}
TODO ("no error must be pending here, else do app shutdown");
//////////////////////////////////////////////////////////////////////TICKET #844 no error must be pending here, else do app shutdown
return 0;
}
@ -322,7 +322,7 @@ lumiera_thread_sync (void)
self->state = LUMIERA_THREADSTATE_SYNCING;
lumiera_condition_signal (&self->signal, &NOBUG_FLAG(threads), NOBUG_CONTEXT);
TODO("error handing, maybe timed mutex (using the threads heartbeat timeout, shortly before timeout)");
//////////////////////////////////////////TICKET #843 error handing, maybe timed mutex (using the threads heartbeat timeout, shortly before timeout)
while (self->state == LUMIERA_THREADSTATE_SYNCING) {
lumiera_condition_wait (&self->signal, &NOBUG_FLAG(threads), self->rh, NOBUG_CONTEXT);

9
src/common/config_lookup.c → src/common/config-lookup.c
View file

@ -23,7 +23,7 @@
#include "lib/safeclib.h"
#include "lib/tmpbuf.h"
#include "common/config_lookup.h"
#include "common/config-lookup.h"
#include "common/config.h"
/* we only use one fatal error for now, when allocation in the config system fail, something else is pretty wrong */
@ -76,7 +76,8 @@ lumiera_config_lookup_insert (LumieraConfigLookup self, LumieraConfigitem item)
REQUIRE (item->key);
REQUIRE (item->key_size);
FIXME ("implement section prefix/suffix for the key");
////////////////////////////////////////TICKET #839 implement section prefix/suffix for the key"
const char* key = lumiera_tmpbuf_strcat3 (NULL, 0, item->key, item->key_size, NULL, 0);
LumieraConfigLookupentry entry = (LumieraConfigLookupentry)psplay_find (&self->tree, key, 100);
@ -101,7 +102,9 @@ lumiera_config_lookup_insert_default (LumieraConfigLookup self, LumieraConfigite
LumieraConfigLookupentry entry = (LumieraConfigLookupentry)psplay_find (&self->tree, key, 100);
if (!entry)
entry = (LumieraConfigLookupentry)psplay_insert (&self->tree, &lumiera_config_lookupentry_new (key)->node, 100);
TODO ("else check that no 'default' item already exists, that is, the tail element's parent points to the 'defaults' in config");
////////////////////////////////////////TICKET #839 check that no 'default' item already exists when inserting a default
////////////////////////////////////////TICKET #839 ...that is, the tail element's parent points to the 'defaults' in config
llist_insert_tail (&entry->configitems, &item->lookup);
return entry;

2
src/common/config_lookup.h → src/common/config-lookup.h
View file

@ -1,5 +1,5 @@
/*
config_lookup.h - Lookup functions for the config subsystem
CONFIG-LOOKUP.h - Lookup functions for the config subsystem
Copyright (C) Lumiera.org
2008, Christian Thaeter <ct@pipapo.org>

2
src/common/config.h
View file

@ -51,7 +51,7 @@ LUMIERA_ERROR_DECLARE (CONFIG_NO_ENTRY);
//TODO: Lumiera header includes//
#include "common/config_lookup.h"
#include "common/config-lookup.h"
#include "common/configitem.h"
//TODO: System includes//

4
src/common/configentry.c
View file

@ -43,7 +43,7 @@ lumiera_configentry_new (LumieraConfigitem tmp)
LumieraConfigentry self = lumiera_malloc (sizeof (*self));
lumiera_configitem_move ((LumieraConfigitem)self, tmp);
TODO ("initialize other stuff here (lookup, parent, ...)");
//////////////////////////////////////////////////////////////////TICKET #839 initialise other stuff here (lookup, parent, ...)
return (LumieraConfigitem)self;
}
@ -52,7 +52,7 @@ lumiera_configentry_new (LumieraConfigitem tmp)
LumieraConfigitem
lumiera_configentry_destroy (LumieraConfigitem self)
{
TODO ("cleanup other stuff here (lookup, parent, ...)");
//////////////////////////////////////////////////////////////////TICKET #839 cleanup other stuff here (lookup, parent, ...)
return self;
}

21
src/common/configitem.c
View file

@ -20,6 +20,13 @@
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
/** @file configitem.c
** create a configitem out of a single line.
**
*/
#include "include/logging.h"
#include "lib/llist.h"
#include "lib/safeclib.h"
@ -43,12 +50,6 @@ static LumieraConfigitem parse_configentry (LumieraConfigitem self, char* itr);
#include <stdint.h>
/**
* @file
* create a configitem out of a single line.
*
*/
LumieraConfigitem
lumiera_configitem_init (LumieraConfigitem self)
@ -176,11 +177,11 @@ lumiera_configitem_parse (LumieraConfigitem self, const char* line)
lumiera_free (self->line);
self->line = lumiera_strndup (line, SIZE_MAX);
FIXME ("MOCKUP START");
/////////////////////////TODO do a real startup here
char* itr = self->line;
/* skip leading whitespaces */
/* skip leading whitespace */
while (*itr && isspace (*itr))
itr++;
@ -215,7 +216,7 @@ parse_directive (LumieraConfigitem self, char* itr)
/* itr points now to @ */
self->key = itr;
/* check whether there are illegal whitespaces after @ */
/* check whether there are illegal whitespace after @ */
itr++;
if (*itr && !isspace(*itr))
{
@ -224,7 +225,7 @@ parse_directive (LumieraConfigitem self, char* itr)
itr += self->key_size;
/* we need a key with a length greather than zero and */
/* we need a key with a length greater than zero and */
/* either end of line or whitespace after key */
if ( self->key_size && ( !*itr || (*itr && isspace(*itr)) ))

2
src/common/configitem.h
View file

@ -33,7 +33,7 @@ typedef lumiera_configitem* LumieraConfigitem;
struct lumiera_configitem_vtable;
//TODO: Lumiera header includes//
#include "common/config_lookup.h"
#include "common/config-lookup.h"
//TODO: System includes//

4
src/gui/Makefile.am
View file

@ -112,9 +112,9 @@ gtk_gui_la_SOURCES = \
$(lumigui_srcdir)/widgets/timecode-widget.hpp \
$(lumigui_srcdir)/widgets/timeline-widget.cpp \
$(lumigui_srcdir)/widgets/timeline-widget.hpp \
$(lumigui_srcdir)/widgets/timeline/basic-draw-strategy.cpp \
$(lumigui_srcdir)/widgets/timeline/basic-draw-strategy.hpp \
$(lumigui_srcdir)/widgets/timeline/draw-strategy.hpp \
$(lumigui_srcdir)/widgets/timeline/draw-strategy.cpp \
$(lumigui_srcdir)/widgets/timeline/draw-strategy.hpp \
$(lumigui_srcdir)/widgets/timeline/timeline-arrow-tool.cpp \
$(lumigui_srcdir)/widgets/timeline/timeline-arrow-tool.hpp \
$(lumigui_srcdir)/widgets/timeline/timeline-body.cpp \

12
src/lib/Makefile.am
View file

@ -63,6 +63,7 @@ liblumiera_la_SOURCES = \
$(liblumiera_la_srcdir)/test/testoption.cpp \
$(liblumiera_la_srcdir)/time.cpp \
$(liblumiera_la_srcdir)/time/lumitime.cpp \
$(liblumiera_la_srcdir)/time/mutation.cpp \
$(liblumiera_la_srcdir)/time/quantiser.cpp \
$(liblumiera_la_srcdir)/time/timecode.cpp \
$(liblumiera_la_srcdir)/tmpbuf.c \
@ -83,7 +84,6 @@ noinst_HEADERS += \
$(liblumiera_la_srcdir)/lifecycleregistry.hpp \
$(liblumiera_la_srcdir)/lockerror.h \
$(liblumiera_la_srcdir)/luid.h \
$(liblumiera_la_srcdir)/lumitime.hpp \
$(liblumiera_la_srcdir)/meta/configflags.hpp \
$(liblumiera_la_srcdir)/meta/generator.hpp \
$(liblumiera_la_srcdir)/meta/typelist-util.hpp \
@ -110,12 +110,20 @@ noinst_HEADERS += \
$(liblumiera_la_srcdir)/singleton.hpp \
$(liblumiera_la_srcdir)/sync-classlock.hpp \
$(liblumiera_la_srcdir)/sync.hpp \
$(liblumiera_la_srcdir)/test/mockinjector.hpp \
$(liblumiera_la_srcdir)/test/run.hpp \
$(liblumiera_la_srcdir)/test/suite.hpp \
$(liblumiera_la_srcdir)/test/test-helper.hpp \
$(liblumiera_la_srcdir)/test/testoption.hpp \
$(liblumiera_la_srcdir)/time.h \
$(liblumiera_la_srcdir)/time/diagnostics.hpp \
$(liblumiera_la_srcdir)/time/digxel.hpp \
$(liblumiera_la_srcdir)/time/display.hpp \
$(liblumiera_la_srcdir)/time/formats.hpp \
$(liblumiera_la_srcdir)/time/grid.hpp \
$(liblumiera_la_srcdir)/time/mutation.hpp \
$(liblumiera_la_srcdir)/time/quantiser.hpp \
$(liblumiera_la_srcdir)/time/timecode.hpp \
$(liblumiera_la_srcdir)/time/timevalue.hpp \
$(liblumiera_la_srcdir)/tmpbuf.h \
$(liblumiera_la_srcdir)/tree.hpp \
$(liblumiera_la_srcdir)/util.hpp \

2
src/lib/hash_fnv.c → src/lib/hash-fnv.c
View file

@ -39,7 +39,7 @@ slightly modified and adapted to C99; no copyright applies:
*/
#include "hash_fnv.h"
#include "lib/hash-fnv.h"
#include <nobug.h>

2
src/lib/hash_fnv.h → src/lib/hash-fnv.h
View file

@ -1,5 +1,5 @@
/*
hash_fnv.c - FNV hash functions
HASH-FNV.h - FNV hash functions
Copyright (C)
2010, 2011, Christian Thaeter <ct@pipapo.org>

1
src/lib/test/suite.cpp
View file

@ -165,6 +165,7 @@ namespace test {
{
try
{
INFO (test, "++------------------- invoking TEST: %s", showType(theTest).c());
theTest.run (cmdline);
return Suite::TEST_OK;
}

4
src/proc/asset/media.cpp
View file

@ -149,7 +149,7 @@ namespace asset {
asset::Media* pM (0);
AssetManager& aMang = AssetManager::instance();
TODO ("check and fix Category if necessary");
//////////////////////////////////////////////////////////TICKET #841 check and fix Category if necessary
if (isnil (file))
{
@ -168,7 +168,7 @@ namespace asset {
MediaDesc& handle = maf.queryFile(key.name);
Duration length = handle.length;
TODO ("detecting and wiring multichannel compound media!");
//////////////////////////////////////////////////////////TICKET #841 detecting and wiring multichannel compound media
pM = new Media (key,file,length);
}
ASSERT (pM);

4
src/proc/assetmanager.cpp
View file

@ -111,11 +111,11 @@ namespace asset {
{
AssetManager& _aMang (AssetManager::instance());
DB& registry (_aMang.registry);
TODO ("check validity of Ident Category");
//////////////////////////////////////////////////////////TICKET #840 check validity of Ident Category
ID<KIND> asset_id (getID (idi));
DB::Lock guard(&registry);
TODO ("handle duplicate Registrations");
//////////////////////////////////////////////////////////TICKET #840 handle duplicate Registrations
P<KIND> smart_ptr (obj, &destroy);
registry.put (asset_id, smart_ptr);

2
src/proc/mobject/session/sess-manager-impl.cpp
View file

@ -210,7 +210,7 @@ namespace session {
SessManagerImpl::~SessManagerImpl ()
{
TODO ("verify sane lifecycle");
//////////////////////////////////////// TICKET #845 verify sane session manager lifecycle here
Session::initFlag = false;
}

4
src/tool/SConscript
View file

@ -12,12 +12,12 @@ envSvg.mergeConf(['librsvg-2.0'])
envSvg.Append(LIBS=support_lib)
luidgen = env.Program('luidgen', 'luidgen.c', LIBS=support_lib, install=True) ## for generating Lumiera-UIDs
luidgen = env.Program('luidgen', ['luidgen.c'] + support_lib, install=True) ## for generating Lumiera-UIDs
rsvg = envSvg.Program('rsvg-convert','rsvg-convert.c') ## for rendering SVG icons (uses librsvg)
# build additional test and administrative tools....
artifacts['tools'] = [ env.Program('hello-world','hello.c', install=True) #### hello world (checks C build)
+ env.Program('try', 'try.cpp', LIBS=support_lib) #### to try out some feature...
+ env.Program('try', ['try.cpp'] + support_lib) #### to try out some feature...
+ luidgen
+ rsvg
]

2
tests/45controller.tests
View file

@ -38,7 +38,7 @@ END
TEST "build argument accepting function" ArgumentTupleAccept_test <<END
out: sizeof\( .+control.+TestClass.+ \) = 1
out: sizeof\( .+control.+TestClass.+lib.time.TimeVar.+ \) = (12|16)
out: 0:..:..\.000
out: 0:..:..\..00
return: 0
END

1
tests/components/Makefile.am
View file

@ -111,7 +111,6 @@ test_components_SOURCES = \
noinst_HEADERS += \
$(testcomponents_srcdir)/backend/mediaaccessmock.hpp \
$(testcomponents_srcdir)/proc/asset/asset-diagnostics.hpp \
$(testcomponents_srcdir)/proc/asset/testasset.hpp \
$(testcomponents_srcdir)/proc/asset/testclipasset.hpp \