Kino

by  Arne Schirmacher <kino@schirmacher.de>
    Dan Dennedy <dan@dennedy.org>
    Charlie Yates <charles.yates@pandora.be>
	Mads Bondo Dydensborg <madsdyd@challenge.dk>
main user site: http://www.kinodv.org/
bug reports site: http://jira.schirmacher.de/jira-kino/
developer site: http://sf.net/projects/kino/

-----------------------------------------------------------------------------
Introduction
-----------------------------------------------------------------------------
Kino is a non-linear DV editor for GNU/Linux. It features excellent
integration with IEEE 1394 for capture, VTR control, and recording back to
the camera. It captures video to disk in AVI format in both type-1
DV and type-2 DV (separate audio stream) encodings.

You can load multiple video clips into a playlist, cut and paste portions of
video/audio, and save it to a playlist. Most edit and navigation commands are
mapped to equivalent vi key commands. Also, Kino can load playlists and 
save the composite playlist as a new DV AVI file. Finally, Kino can save a
single frame of video (a still) in numerous file formats (based upon file
extension).

Currently, Kino does not support other video file formats or encodings. It
does not support multiple layers or tracks of video and audio. It does not
do image processing, titling, transitions, or effects. We plan to implement
most of these features, but first we chose to focus on the basics of IEEE
1394, video, audio, and file input and output. We place a lot of emphasis
on quality, stability, performance, and workflow.

For more information, please read the NEWS file, which contains functional
changes and important notices for each new version. The ChangeLog contains
a more detailed, technical account of the changes in each version. Valuable
information is contained in these files unless you can read C/C++ source 
code. Also, the discussion forums on the user website above are very
helpful.

-----------------------------------------------------------------------------
Requirements and Recommendations
-----------------------------------------------------------------------------
libdv is the required DV codec that we use.
(http://sf.net/projects/libdv/)

The Linux IEEE 1394 subsystem is required for DV/1394 I/O. Linux1394 comes
with Linux kernels 2.4+; a patch is available for kernel 2.2 from the project
website.
(http://www.linux1394.org/)

Every linux1394 installation also needs libraw1394.
(http://www.linux1394.org/)

Libavc1394 is required for compilation even if you do not have IEEE 1394.
It provides camera capabilities discovery, and VTR control.
(http://sf.net/projects/libavc1394/)

GTK 2.6 is required and provides most of the additional packages need to
build Kino. You will need both the runtime and -dev packages to compile Kino.

We currently support GDK or XVideo for the computer video display. XVideo (Xv)
is strongly recommended for performance reasons. XFree86 4.x and a compatible
display adapater and driver are required for XVideo extensions. We currently
require XFree86 4.x for building Kino, but if you have an older version, then
simply edit src/Makefile.am and remove "-lXv" from the line beginning with
"kino_LDADD=".

We currently only support OSS and ALSA audio, not esd or arts. You can disable
audio if you need to.

-----------------------------------------------------------------------------
Build and Installation
-----------------------------------------------------------------------------
Following is a list of libraries used during linking:

libgthread-2.0 
libglade-2.0
libgtk-x11-2.0
libgdk-x11-2.0
libatk-1.0
libgdk_pixbuf-2.0
libpangoxft-1.0
libpangox
libpango-1.0
libgobject-2.0
libgmodule-2.0
libglib-2.0
libsamplerate
libXv
libXext
libasound
libpthread
librom1394
libavc1394
libraw1394
libdv
libSM
libICE
libxml2
libstdc++
libc
libgcc
libdl
libz
libm

Additional libs that are dependencies of these libs may include:
libX11
libXrandr
libXi
libXinerama
libXft
libfreetype
libfontconfig
libXfixes
libXrender
libpangoft2-1.0
libexpat

You must have installed GTK2 and libglade and its -dev packages, in addition
to the DV/1394-specific packages.

0. Upgrade to XFree86 4.x. After doing so, run the xvinfo utility command to
    see if you display adapater supports XVideo. Consider purchasing a new
    display adapter if it does not support XVideo. 
1. Setup linux1394 per the Getting Started Guide on their website.
2. Install libdv.
3. Install libavc1394.
4. test capture using dvgrab. (You may find that you need to enable DMA on
    your IDE hard drive using the hdparm utility.)
    You can get dvgrab from http://www.kinodv.org/.
5. Install Kino:
    ./configure
    make
    su
    make install
    exit
    
    IMPORTANT:
    You must do the 'make install' step or Kino will not be able to load
    its button images or the online help. Currently, a 'make uninstall'
    does not delete the items; however, it does delete the binary and
    man page.
    
6. run kino

If you want to use Quicktime DV files, then install Quicktime 4 Linux
(http://www.heroinewarrior.com/) or a compatible
(http://sf.net/projects/libquicktime) library. Then, you must run the
configure script with the --with-quicktime option.

You may want to use ffmpeg's libavcodec to decode DV video instead of libdv.
For instance, libavcodec has accelleration for PowerPC in addition to SSE/MMX,
whereas libdv only has MMX accelleration. However, Kino still needs libdv to
support audio and metadata. Run the configure script with the --with-avcodec
option as well as --with-avcodec-include=<path to libavcodec includes directory>
and --with-avcodec-lib=<path to libavcodec static library.a>.

-----------------------------------------------------------------------------
Getting Started
-----------------------------------------------------------------------------
After starting Kino, we suggest that you review Preferences to setup the
initial configuration. After loading some AVIs, you can tweak various settings
for the best performance and experience.

When you load an AVI, Kino attempts to detect scenes by looking for
discontinuities in the timecode. It renders each scene break with a vertical
line in the location indicator at the bottom of the window. Kino also refers
to scenes as sequences.

Likewise, when you capture video and enable autosplit, Kino detects scene 
changes in your source video file and generates a new AVI file. Autosplit
also tells Kino to start a new file when it exceeds the maximum number of
frames per file (as set in Preferences). You also set the filename to capture
to in Preferences.

We strongly suggest you use the keyboard commands instead of the menus and
toolbar. There are for more keybaord commands than there are menu options.

-----------------------------------------------------------------------------
HELP!
-----------------------------------------------------------------------------

Please read the online documentation for more information.

If Kino has trouble launching the online help, make sure you
properly configure a default web browser in the GNOME or KDE Control Center.
If you run Kino from the console/shell, then it reports on stdout the 
command it attempts to use to launch the online help. That should help debug
issues. If all else fails, then directly access the documents at
$prefix/share/kino/help/
where "$prefix" is usually either "/usr" or "/usr/local" -- if not, then you
probably know what it is!

Finally, you can consult the Kino discussion forum
or authors using the information at the top of this README.
