test not only if header frei0r.h exists, also use an item
[mlt-frei0r-support.git] / shotcut / docs / faq.txt
blob6831178b7c0248bea19e47d8ba4478d613b67591
1 FAQ
2 ---
4 WHAT IS SHOTCUT?
6         Shotcut is a video editing environment specifically designed for TV 
7         broadcasters. 
10 WHAT PLATFORMS DOES IT RUN ON?
12         It's been developed on the Linux platform, but it should be relatively 
13         simple to port to other POSIX environments, such as the BSD platforms.
16 WHAT ARE ITS DEPENDENCIES?
18         The multimedia components are provided via the MLT framework and the GUI
19         toolkit used is FLTK.
22 WHAT'S THE LICENSE USED?
24         It's developed under the GPL license and the copyright holder is Ushodaya 
25         Enterprises Limited.
28 WHAT COMPONENTS DOES IT PROVIDE?
30         Shotcut consists of a number of components. 
32         * The Non Linear Editor (NLE) is the main component for project creation
33         * The Preview is a standalone player for optionally examining clips, images 
34           and audio prior to including them in the NLE
35         * The Editor is a text editor which is specifically tailored for the shotcut
36           XML project format
37         * The Server provides a background proxy process which connects multiple
38           instances of the other components together
39         * The Injector is a command line tool which can be used to introduce media 
40           into the shotcut environment
41         * The Window Manager (WM) provides a complete tailored environment for 
42           staging the shotcut components.
44         More details can be found in the main README of the project.
47 HOW DOES IT DIFFER TO A TRADITIONAL VIDEO EDITOR?
49         Video editors generally feature a lot of configurability when it comes
50         to the application of filters, transitions and track usage - shotcut is 
51         designed to restrict the options available to the user in order to ensure
52         consistency between projects and a quick turn around time.
55 WHAT ARE THE ADVANTAGES? WHY NOT USE AN OFF THE SHELF PACKAGE?
57         The complex UI designs associated to video editors are counter productive 
58         to a broadcasting organisation which really needs a quick turn around and
59         a consistent look and feel to their broadcast material. By restricting the
60         options available and automating many of the tasks, user training and the
61         risk of errors being broadcast are reduced.
64 WHAT'S A TEMPLATE?
66         A Template is designed to provide a channel or program 'branding' - 
67         administrators can define new templates to activate specific filters and
68         track definitions.
71 HOW DO I CONFIGURE NEW TEMPLATES?
73         There are no tools available to automate the template design and there is some 
74         tight coupling between the GUI components and the templates which currently 
75         restrict the amount of configurability available.
76         
77         See docs/templates.txt for more information.
80 HOW DO YOU OPEN VIDEO CLIPS/AUDIO/IMAGES IN THE NLE?
82         Shotcut doesn't provide a traditional drop down menu, hence the normal 
83         File Open operations aren't available and nor is drag n drop supported. 
84         Instead, clips are 'injected' into it from other applications.
85         
86         While this might seem strange, the general idea is that it allows 
87         collaborative editing with external applications being capable of doing
88         complex editing operations which are then passed from component to
89         component. If you have a network share for the media itself, these
90         components can run on different machines. They can also be scripted using
91         shell, perl, ruby, tcl or python.
93         As a result of this design, there are many ways to introduce content 
94         into the NLE - the simplest is from the command line:
96         $ shotcut-inject --port=5260 <files>
98         But other approaches are available when used in conjuction with other
99         shotcut components and mlt based tools. Check the README for specific
100         details on how to configure the shotcut components.
103 IS IT USEFUL FOR HOME USE?
105         That depends on your requirements of a video editing environment. It wasn't 
106         designed with general use in mind, but for specific tasks, it may be useful.
109 COULD IT BE USED FOR WEB BROADCASTING?
111         Yes. The MLT framework is very extendible and is already quite feature rich.
114 WHAT FORMATS DOES IT SUPPORT?
116         It supports all formats that are supported by the MLT framework.
119 WILL IT EVER BECOME A FULLY FEATURED TRADITIONAL NLE?
121         No. That would go against the objective of the project. There are plans to 
122         provide a fully featured video editor based on MLT though, but at the point
123         of writing, these details have not been finalised.