# This file is part of Videoporama
# Videoporama is a program to make diaporama export in video file
# Copyright (C) 2007-2010  Olivier Ponchaut <opvg@numericable.be> - Dominique Levray

# 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.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

DESCRIPTION :

VIDEOPORAMA (IMAGES2DV-GUI) : convert images sequence on a RAW DV files for use in DV native video montage (with Kino or Cinelerra for example). Since version 0.2, it can also export in MPEG (VCD, SVCD, XVCD, DVD). Since version 0.7, it can also export in flv and h264 (mpeg4 part 10 AVC) and in different resolution, from 384x288 to 1920x1080 full HD.


This application use this packages :  	'python  ver >= 2.5 but not yet 3.x
            'qt	    ver >= 4.4 (Best to use Qt 4.6 and above)
            'pyqt'   ver >= 4.x
            'pil'    ver >= ? (Python Image Library)
            'FFmpeg' ver >= ?
            'SoX' ver >= ? 
            'mjpegtools' ver >= 1.8
            'mplayer' ver >= ?

This application used this externals binary programs :
 - 'ffmpeg'    from FFmpeg to encode image to video.
 - 'sox'       from SoX to transcode audio file to wav or to mp2
 - 'ppmtoy4m'  from MJpegtools to convert ppm images to yuv4mpeg format. 
 - 'mplayer'   from mplayer to play video and preview


ABOUT VIDEO TYPES AND FORMATS SUPPORTED BY THIS APPLICATION :

  Video type   ::  RAW DV, DV AVI,         :
               ::  VCD, SVCD, XVCD, DVD    :
               ::  FLV, H264               :
  Video format :: PAL/SECAM   :     NTSC   :   WEB    : HD Ready :  Full HD  : 
               ::             :            :          :          :           :
  Resolution   ::  720x576    :    720x480 :  384x288 : 1280x720 : 1920x1080 :
               ::             :            :          :          :           :
  Frame/s      ::    25       :      30    :    25    :    25    :    25     :
               ::             :            :          :          :           :
  Sound format ::                   WAV | MP3 | OGG                          :
               ::                                                            :
  Image        ::                      excellent                             :
               ::                                                            :
  restitution  ::                     4:3 or 16:9                            :

See help documentation for more info
-------------------------------------------------------------------------------

AUTHOR : PONCHAUT Olivier <opvg at numericable dot be> - LEVRAY Dominique

CONTRIBUTION : 
  - ERIK : Ideas about new user's interface
  - Iacopo Spalletti : Improvement on user's interface (resize, ...)
  - Lino Fantasia : Italian translation
  - Redy Rodriguez : Spanish translation
  - Chris Clayton : Patch and bugs fixes
  - Angelo Lama (EKD Project) : QWidget mplayer
-------------------------------------------------------------------------------

TODO :

See Videoporama web site, developpment part to see the roadmap on flyspray
-------------------------------------------------------------------------------

HELP AND USER'S GUIDE

User's guide in english and french are available inside Videoporama and on the videoporama website : http://videoporama.tuxfamily.org

-------------------------------------------------------------------------------

LICENSE :

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, or (at your option)
any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program (see licences.txt file); if not, write to the Free Software
Foundation, Inc., 51 Franklin Steet, Fifth Floor, Boston, MA
02111-1307, USA.

----------------------------------------------------------- --------------------------------------------
CHANGELOG :

* Version 0.8.1-Alpha1 : 08/2010
      - Improvements on interface :
          - Copy/Cut/Paste functions
          - Modification of Render and Configuration dialog box
      - Bugs fixings

* Version 0.8 : 07/2010
      - Key burn effect on multiple point and with fixe plan possible.
      - Text overlaid on full montage
      - Improvements on interface :
          - Show transition type on timeline thumbnails
          - Help button
          - New dialog box to define text, zoom point, ...
      - Texts on image : With or without background shape.
      - Bugs fixings

History :

* version 0.1 : first release in 10/2007 by Olivier Ponchaut - <opvg@numericable.be>
* version 0.2 : 11/2007 
      - New transitions added 
      - Export to VCD, SVCD, XVCD and DVD
      - Possibility to specify transition type to each image
      - New icons
      - Bugs fixes
* version 0.3 : 12/2007
      - Add luma transition
      - New GUI
      - Add plugin structure to add new transition
      - Install script by distutils
      - Config files in user's folder (hidden folder)
      - Sound automatically adapted to video's length.
* version 0.4 : 12/2007
      - Bugs fixes
      - Image preview
* version 0.5 : 12/2007
      - New name : Videoporama
      - New GUI with image preview 
      - Interface improvement
* version 0.6 : 09/2008
      - QT4 !
      - Complete new GUI, more intuitive, more beautiful
      - Add text insersion
      - Improve performances
      - Display image while processing
      - bugs fixes
* version 0.7 : 01/2009
      - Add key burn effect 
      - Interface improvement (resize)
      - Add new export format (FLV, H264 AVC)
      - Export in new resolution (Web (384x288), PAL/SECAM (720x576), NTSC (720x480), HD 720 (1280x720) and HD 1080 (1920x1080))
      - Use of FFmpeg to encode images to video format (no more need of libDV and DVgrab)
      - Use of PIL instead of ImageMagick for transitions and image manipulation. Encoding process is much faster !!!
      - Windows version in beta status
      - bugs fixes and lots of code improvement
* version 0.7.1 : 04/2009
      - Bugs fixes
* version 0.7.3 : 05/2009
      - Bugs fixes
      - Image option definition in batch
* version 0.7.4 : 05/2009
      - Bugs fixes
* version 0.7.5 : 05/2009
      - Fixes packages + licences text
* version 0.7.6 : 07/2009
      - Correction bug in preview function
      - Correction about non ASCII character in url's
      - More checks about dependenties and warning message if somes are missing or not complete
      - Add module to view video (with mplayer)
      - Add view result (after encoding process finished, also with mplayer)
-------------------------------------------------------------------------------

INSTALL :

You just have to unzip archive, go to it and execute, in superuser :
  # python setup.py install

-------------------------------------------------------------------------------

PORTABLE USAGE :
You just have to unzip archive, go to it and execute, in normal user :
  $ videoporama --locale 

or

  $ python start.py -l
