doccliptextfile.cpp

/***************************************************************************
                          doccliptextfile.cpp  -  description
                             -------------------
    begin                : Jan 31 2006
    copyright            : (C) 2006 by Jean-Baptiste Mardelle
    email                : jb@ader.ch

 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/

#include "doccliptextfile.h"

#include <iostream>
#include <assert.h>

#include <qfileinfo.h>

#include <kdebug.h>
#include <klocale.h>
#include <kio/netaccess.h>

#include "clipmanager.h"
#include "kdenlivesettings.h"



DocClipTextFile::DocClipTextFile(const QString & name, const KURL & url,
    uint id):DocClipBase(),m_clipType(TEXT), m_duration(0.0), m_url(url),
m_durationKnown(false), m_framesPerSecond(0),
 m_alphaTransparency(false)
{
    setName(name);
    setId(id);
}


DocClipTextFile::DocClipTextFile(const QString & name, const QString & text, const GenTime & duration, const QDomDocument &xml, KURL url, const QPixmap &pix, bool transparency, uint id):DocClipBase(),m_clipType(TEXT), m_duration(duration), m_url(url),
 m_durationKnown(true), m_framesPerSecond(KdenliveSettings::defaultfps()), m_filesize(0), m_xml(xml), m_alphaTransparency(transparency)
{
    setName(name);
    setId(id);
    setDescription( text );
    setThumbnail(pix);
}


DocClipTextFile::DocClipTextFile(const KURL & url):DocClipBase(),
 m_clipType(TEXT),
m_duration(0.0),
m_url(url),
m_durationKnown(false),
m_framesPerSecond(0), m_alphaTransparency(false)
{
    setName(url.fileName());
}


DocClipTextFile::DocClipTextFile(QDomDocument node):DocClipBase(),m_clipType(TEXT), m_duration(0.0),  m_durationKnown(false), m_framesPerSecond(0), m_alphaTransparency(false)
{
QDomElement element = node.documentElement(); 
 if (element.tagName() != "kdenliveclip") {
      kdWarning() <<
          "DocClipRef::createClip() element has unknown tagName : " <<
          element.tagName() << endl;
      return;
    }

    QDomNode n = element.firstChild();

    while (!n.isNull()) {
      QDomElement e = n.toElement();
      if (!e.isNull()) {
          //kdWarning() << "DocClipRef::createClip() tag = " << e.tagName() << endl;
          if (e.tagName() == "avfile") {
            m_url = KURL(e.attribute("url", QString::null));
                setId(e.attribute("id", "-1").toInt());
                m_filesize = e.attribute("filesize", "0").toInt();
            m_alphaTransparency = e.attribute("transparency", "0").toInt();
            m_width = e.attribute("width", "0").toInt();
            m_height = e.attribute("height", "0").toInt();
            m_durationKnown = e.attribute("durationknown", "0" ).toInt();
            m_color = e.attribute("color", QString::null);
            m_duration = GenTime(e.attribute("duration", "0").toInt(), KdenliveSettings::defaultfps());
            setName(e.attribute("name", QString::null));
            setDescription(e.attribute("description", QString::null));
            QDomDocument xml;
            xml.appendChild(e.firstChild());
                //xml.setContent(e.attribute("textxml", QString::null));
            setTextClipXml( xml);
          }
      }
      n = n.nextSibling();
    }

}

DocClipTextFile::~DocClipTextFile()
{
}

void DocClipTextFile::removeTmpFile() const
{
    KIO::NetAccess::del(m_url);
}

00114 const GenTime & DocClipTextFile::duration() const
{
    return m_duration;
}

00119 const DocClipBase::CLIPTYPE & DocClipTextFile::clipType() const
{
    return m_clipType;
}


00125 const KURL & DocClipTextFile::fileURL() const
{
    return m_url;
}

const QDomDocument & DocClipTextFile::textClipXml() const
{
    return m_xml;
}

void DocClipTextFile::setTextClipXml(const QDomDocument &xml)
{
    m_xml = xml;
}

void DocClipTextFile::setAlpha(bool transp)
{
    m_alphaTransparency = transp;
}

bool DocClipTextFile::isTransparent()
{
    return m_alphaTransparency;
}

00150 DocClipTextFile *DocClipTextFile::createClip(const QDomElement element)
{
    /*
      DocClipTextFile *file = 0;


      if(element.tagName() == "avfile") {
            KURL url(element.attribute("url"));
            file = new DocClipTextFile(url.filename(), url);
      } else {
            kdWarning() << "DocClipTextFile::createClip failed to generate clip" << endl;
      }

      return file;
    */
}

00167 void DocClipTextFile::setFileURL(const KURL & url)
{
    m_url = url;
    QFileInfo fileInfo(m_url.path());
    /* Determines the size of the file */
    m_filesize = fileInfo.size();
}

00175 void DocClipTextFile::setDuration(const GenTime & duration)
{
    m_durationKnown = true;
    m_duration = duration;
}


00182 bool DocClipTextFile::durationKnown() const
{
    return m_durationKnown;
}

// virtual
double DocClipTextFile::framesPerSecond() const
{
    return m_framesPerSecond;
}

//returns clip video properties -reh
uint DocClipTextFile::clipHeight() const
{
    return KdenliveSettings::defaultheight();
}

uint DocClipTextFile::clipWidth() const
{
    return clipHeight() * KdenliveSettings::displayratio();
}

double DocClipTextFile::aspectRatio() const
{
    double ratio = ((double) KdenliveSettings::defaultwidth()/KdenliveSettings::defaultheight())/((double)KdenliveSettings::displayratio()) * KdenliveSettings::aspectratio();
    return ratio;
}

// virtual
QDomDocument DocClipTextFile::sceneToXML(const GenTime & startTime,
    const GenTime & endTime) const
{
}

// virtual
QDomDocument DocClipTextFile::generateSceneList(bool, bool) const
{
    QDomDocument sceneList;
    QDomElement westley = sceneList.createElement("westley");
    sceneList.appendChild(westley);

    QDomElement producer = sceneList.createElement("producer");
    producer.setAttribute("id", 0);
    producer.setAttribute("resource", fileURL().path());
    //producer.setAttribute("aspect_ratio", QString::number(KdenliveSettings::aspectratio()));
    westley.appendChild(producer);
    QDomElement playlist = sceneList.createElement("playlist");
    playlist.setAttribute("in", "0");
    playlist.setAttribute("out", QString::number(duration().frames(KdenliveSettings::defaultfps())));
    QDomElement entry = sceneList.createElement("entry");
    entry.setAttribute("producer", 0);
    playlist.appendChild(entry);
    westley.appendChild(playlist);
    /*

      QDomElement westley = sceneList.createElement("westley");
      sceneList.appendChild(westley);

      QDomElement producer = sceneList.createElement("producer");
      producer.setAttribute("id", QString("producer0"));
      producer.setAttribute("mlt_service", "pango");
        producer.setAttribute("text", description());
        producer.setAttribute("text", description());
        producer.setAttribute("bgcolour", "0x000000ff");
      westley.appendChild(producer);
      QDomElement playlist = sceneList.createElement("playlist");
      playlist.setAttribute("in", "0");
      playlist.setAttribute("out",
          QString::number(duration().frames(25)));
      QDomElement entry = sceneList.createElement("entry");
      entry.setAttribute("producer", QString("producer0"));
      playlist.appendChild(entry);
    westley.appendChild(playlist);*/

    return sceneList;
}

void DocClipTextFile::populateSceneTimes(QValueVector < GenTime >
    &toPopulate) const
{
    toPopulate.append(GenTime(0));
    toPopulate.append(duration());
}

00266 uint DocClipTextFile::fileSize() const
{
    return m_filesize;
}

00271 uint DocClipTextFile::numReferences() const
{
#warning TODO - write this funtion.
}


// virtual
00278 bool DocClipTextFile::referencesClip(DocClipBase * clip) const
{
    return this == clip;
}

// virtual
QDomDocument DocClipTextFile::toXML() const
{
    QDomDocument doc = DocClipBase::toXML();
    QDomNode node = doc.firstChild();

    while (!node.isNull()) {
      QDomElement element = node.toElement();
      if (!element.isNull()) {
          if (element.tagName() == "kdenliveclip") {
            QDomElement avfile = doc.createElement("avfile");
            avfile.setAttribute("url", m_url.path());
            avfile.setAttribute("type", m_clipType);
                avfile.setAttribute("id", getId());
            avfile.setAttribute("duration", m_duration.frames(KdenliveSettings::defaultfps()));
            avfile.setAttribute("durationknown", m_durationKnown );
                avfile.setAttribute("filesize", m_filesize);
            avfile.setAttribute("transparency", m_alphaTransparency);
            avfile.setAttribute("color", m_color);
            avfile.setAttribute("description", description());
            avfile.setAttribute("name", name());
            //avfile.setAttribute("textxml", m_xml.toString());
            avfile.setAttribute("width", m_width);
            avfile.setAttribute("height", m_height);
            avfile.appendChild(avfile.ownerDocument().importNode(m_xml.documentElement(), true));
            element.appendChild(avfile);
            
            return doc;
          }
      }
      node = node.nextSibling();
    }


    assert(node.isNull());

    /* This final return should never be reached, it is here to remove compiler warning. */
    return doc;
}

// virtual
00324 bool DocClipTextFile::matchesXML(const QDomElement & element) const
{
    bool result = false;

    if (element.tagName() == "kdenliveclip") {
      bool found = false;
      QDomNode n = element.firstChild();
      while (!n.isNull()) {
          QDomElement avElement = n.toElement();      // try to convert the node to an element.

          if (!avElement.isNull()) {
            if (avElement.tagName() == "avfile") {
                if (found) {
                  kdWarning() <<
                      "Clip contains multiple avclip definitions, only matching XML of the first one,"
                      << endl;
                  break;
                } else {
                  found = true;
                  //if(avElement.attribute("url") == fileURL().url()) {
                  if (avElement.attribute("id") ==
                      QString::number(getId())) {
                      result = true;
                  }
                }
            }
          }

          n = n.nextSibling();
      }
    }

    return result;
}