kdenparse.py

#!/usr/bin/python
# Copyright 2011 Will Riley
# Distributed under the terms of the GNU General Public License v3

"""
 kdenparse.py
 
 KdenParse attempts to extract and present useful information 
 from a .kdenlive XML project file.
 
 Kdenlive video editing software can be found here:
 http://www.kdenlive.org

"""
# import os, sys, argparse
# 
# version_ = "%(prog)s 0.1.0"
# 
# argparser = argparse.ArgumentParser(prog="kdenparse.py", 
#     add_help=True,
#     description="Parses .kdenlive project files for various metadata and timeline informations.")
# argparser.add_argument('-V', '--version', 
#     action='version', 
#     version=version_)
# argparser.add_argument('--edl', action='store_true', default=False,
#     dest='create_edl',
#     help='Generate EDL output.')
# argparser.add_argument('--deref-proxy', action='store_true', default=False,
#     dest='deref_proxy',
#     help='Dereference proxy clip (show original filenames)')
# argparser.add_argument('--frames', action='store_true', default=False,
#     dest='show_frames',
#     help='Show frames instead of TC when using --edl.')
# argparser.add_argument('--links', action='store_true', default=False,
#     dest='show_links',
#     help='Show source id to filename association.')
# argparser.add_argument('--profile', action='store_true', default=False,
#     dest='get_profile',
#     help='Generate project profile metadata.')
# argparser.add_argument('--producers', action='store_true', default=False,
#     dest='get_producers',
#     help='Show MLT producers (media file) metadata.')
# argparser.add_argument('--kproducers', action='store_true', default=False,
#     dest='get_kproducers',
#     help='Show Kdenlive producers (media file) metadata.')
# argparser.add_argument('projectFile')
# 
# args = argparser.parse_args()
# 
# if not os.path.isfile(args.projectFile):
#     print "Not a file we can work with..."
#     sys.exit(1)
# 
# try: 
#     args.projectFile.rindex(".kdenlive",-9)
# except ValueError:
#     print "Invalid filename. Exiting."
#     sys.exit(1)

from xml.dom import minidom
from decimal import Decimal,getcontext,ROUND_DOWN
from math import modf, floor

class KdenParse:
        
    def __init__(self, kdenliveFile):
        self.xmldoc = minidom.parse(kdenliveFile)
    
    def getProjectProfile(self):
        profileDict = {}
        profile = self.xmldoc.getElementsByTagName("profile")
        keyList = profile.item(0).attributes.keys()
        for a in keyList:
            profileDict[a] = profile.item(0).attributes[a].value
        return profileDict
    
    def getTracks(self):
        tracks = []
        t = self.xmldoc.getElementsByTagName("track")
        for track in t:
            tracks.append(track.attributes["producer"].value) 
        return tuple(tracks)
    
    def getPlaylists(self):
        playlistList = []
        playlists = self.xmldoc.getElementsByTagName("playlist")
        for p in playlists:
            eventList = []
            plDict = {}
            plDict["pid"] = p.attributes["id"].value
            events = p.getElementsByTagName("entry")
            for event in events:
                evDict = {}
                evDict["producer"] = event.attributes["producer"].value
                evDict["inTime"] = event.attributes["in"].value
                evDict["outTime"] = event.attributes["out"].value
                eventList.append(evDict)
            plDict["events"] = eventList
            playlistList.append(plDict)
        return tuple(playlistList)
    
    def getKProducers(self):
        kProducerList = []
        profile = self.xmldoc.getElementsByTagName("kdenlive_producer")
        for i in profile:
            kpDict = {}
            keyList = i.attributes.keys()
            for a in keyList:
                kpDict[i.attributes[a].name] = i.attributes[a].value
            kProducerList.append(kpDict)
        return tuple(kProducerList)
    
    def getProducers(self):
        producerList = []
        producers = self.xmldoc.getElementsByTagName("producer")
        for p in producers:
            pDict = {}
            pDict["pid"] = p.attributes["id"].value
            pDict["inTime"] = p.attributes["in"].value
            pDict["outTime"] = p.attributes["out"].value
            properties = p.getElementsByTagName("property")
            for props in properties:
                pDict[props.attributes["name"].value.replace(".","_")] = props.firstChild.data 
                
            producerList.append(pDict)
        return tuple(producerList)
    
    def getMainTractor(self):
        tractorList = []
        tractors = self.xmldoc.getElementsByTagName("tractor")
        for t in tractors:
            tid = t.attributes["id"].value
            if tid == "maintractor":
                return t
        raise "maintractor was not found"
    
    def getGivenPlaylist(self,pid):
        playlists = self.xmldoc.getElementsByTagName("playlist")
        for p in playlists:
            pid2 = p.getAttribute("id")
            if pid2 == pid:
                return p
        raise Exception("this playlist: "+pid+" wasnt found")
    
    def getGivenProducer(self,pid):
        producers = self.xmldoc.getElementsByTagName("producer")
        for p in producers:
            pid2 = p.getAttribute("id")
            if pid2 == pid:
                return p
        raise Exception("this producer: "+pid+" wasnt found") 
    
    def linkReferences(self):
        sourceLinks = {}
        for i in self.getProducers():
            srcPid = i["pid"]
            sourceLinks[srcPid] = i["resource"]
        return sourceLinks
    
    def derefProxy(self):
        proxyLinks = {}
        for i in self.getKProducers():
            try:
                if i["proxy"]:
                    _proxy = i["proxy"]
                    proxyLinks[_proxy] = i["resource"]
            except KeyError:
                return False
        return proxyLinks
    

        

    def framesToABS(self, frameAddress):
        getcontext().prec = 10
        getcontext().rounding = ROUND_DOWN
        projectMeta = self.getProjectProfile()
        frameRate = Decimal(projectMeta["frame_rate_num"]) / Decimal(projectMeta["frame_rate_den"])
        frameDuration = 1 / frameRate
        #print "fps = " + str(frameRate)
        #print "1 fr = " + str(frameDuration)  + " secs"
        absDuration = Decimal(frameAddress) * Decimal(frameDuration) # frameAddress length in seconds
        #print "TC = " + str(absDuration)
        f, w = modf(absDuration) # split float at decimal (fraction, whole)
        #print "Split: " + "%f + %f" % (w, f)
        frameRemainder = Decimal(str(f)) / Decimal(frameDuration)
        m, s = divmod(w, 60)
        h, m = divmod(m, 60)
        tc = "%d:%02d:%02d:%02d" % (h, m, s, frameRemainder)
        return tc
        
    def framesToDF(self, framenumber):
        """
            This method adapted from C++ code called "timecode" by Jason Wood.
            begin: Wed Dec 17 2003
            copyright: (C) 2003 by Jason Wood
            email: jasonwood@blueyonder.co.uk 
            Framerate should be 29.97, 59.94, or 23.976, otherwise the calculations will be off.
        """

        projectMeta = self.getProjectProfile()
        framerate = float(projectMeta["frame_rate_num"]) / float(projectMeta["frame_rate_den"])
        
        # Number of frames to drop on the minute marks is the nearest integer to 6% of the framerate
        dropFrames = round(framerate * 0.066666) 
        # Number of frames in an hour
        framesPerHour = round(framerate * 60 * 60) 
        # Number of frames in a day - timecode rolls over after 24 hours
        framesPerDay = framesPerHour * 24 
        # Number of frames per ten minutes
        framesPer10Minutes = round(framerate * 60 * 10) 
        # Number of frames per minute is the round of the framerate * 60 minus the number of dropped frames
        framesPerMinute = (round(framerate) * 60) - dropFrames 
        
        if (framenumber < 0): # For negative time, add 24 hours.
            framenumber = framesPerDay + framenumber

        # If framenumber is greater than 24 hrs, next operation will rollover clock
        # % is the modulus operator, which returns a remainder. a % b = the remainder of a/b

        framenumber = framenumber % framesPerDay 
        d = floor(framenumber / framesPer10Minutes)
        m = framenumber % framesPer10Minutes

        if (m > 1):
            framenumber=framenumber + (dropFrames * 9 * d) + dropFrames * floor((m-dropFrames) / framesPerMinute)
        else:
            framenumber = framenumber + dropFrames * 9 * d;

        frRound = round(framerate);
        frames = framenumber % frRound;
        seconds = floor(framenumber / frRound) % 60;
        minutes = floor(floor(framenumber / frRound) / 60) % 60;
        hours = floor(floor(floor(framenumber / frRound) / 60) / 60);    

        tc = "%d:%02d:%02d;%02d" % (hours, minutes, seconds, frames)
        return tc

    def framesToNDF(self):
        pass
    
# kp = KdenParse(args.projectFile)
# 
# if args.create_edl:
#     kp.createEdl()
# 
# if args.get_profile:
#     for i in kp.getProjectProfile().keys():
#         print i + ": " + kp.getProjectProfile()[i]    
# 
# if args.get_producers:
#     for i in kp.getProducers():
#         print "\n=================\n"
#         for kv in i:
#             print kv + ": " + i[kv]
# 
# if args.get_kproducers:
#     for i in kp.getKProducers():
#         print "\n=================\n"
#         for kv in i:
#             print kv + ": " + i[kv]
#         
# if args.deref_proxy:
#     for i in kp.derefProxy():
#         print i + ": " + kp.derefProxy()[i]
#         
# if args.show_links:
#     for i in kp.linkReferences():
#         print i + ": " + kp.linkReferences()[i]