Permalink
Browse files

Initial commit of FFcast 1.0

  • Loading branch information...
lolilolicon committed Oct 3, 2011
0 parents commit 314e513396674f860028e68971daa710691f99ff
Showing with 748 additions and 0 deletions.
  1. +1 −0 .gitignore
  2. +43 −0 Makefile
  3. +105 −0 README
  4. +2 −0 TODO
  5. +365 −0 ffcast.bash
  6. +232 −0 xrectsel.c
@@ -0,0 +1 @@
+/release/
@@ -0,0 +1,43 @@
+OUT = xrectsel
+VERSION = $(shell git describe)
+
+SRC = ${wildcard *.c}
+OBJ = ${SRC:.c=.o}
+DISTFILES = Makefile README ffcast.bash xrectsel.c
+
+PREFIX ?= /usr
+MANPREFIX ?= ${PREFIX}/share/man
+
+CPPFLAGS := -DVERSION=\"${VERSION}\" ${CPPFLAGS}
+CFLAGS := --std=c99 -g -pedantic -Wall -Wextra -Werror ${CFLAGS}
+LDFLAGS := -lX11 ${LDFLAGS}
+
+all: ${OUT}
+
+${OUT}: ${OBJ}
+ ${CC} -o $@ ${OBJ} ${LDFLAGS}
+
+strip: ${OUT}
+ strip --strip-all ${OUT}
+
+install: xrectsel ffcast.bash
+ install -D -m755 xrectsel ${DESTDIR}${PREFIX}/bin/xrectsel
+ install -D -m755 ffcast.bash ${DESTDIR}${PREFIX}/bin/ffcast
+
+uninstall:
+ @echo removing executable file from ${DESTDIR}${PREFIX}/bin
+ rm -f ${DESTDIR}${PREFIX}/bin/xrectsel
+ rm -f ${DESTDIR}${PREFIX}/bin/ffcast
+
+dist: clean
+ mkdir ffcast-${VERSION}
+ cp ${DISTFILES} ffcast-${VERSION}
+ sed "s/\(^VERSION *\)= .*/\1= ${VERSION}/" < Makefile > ffcast-${VERSION}/Makefile
+ sed "s/@VERSION[@]/${VERSION}/g" < ffcast.bash > ffcast-${VERSION}/ffcast.bash
+ tar czf ffcast-${VERSION}.tar.gz ffcast-${VERSION}
+ rm -rf ffcast-${VERSION}
+
+clean:
+ ${RM} ${OUT} ${OBJ}
+
+.PHONY: clean dist install uninstall
105 README
@@ -0,0 +1,105 @@
+FFcast
+======
+
+FFcast helps the user interactively select a screen region and hands over the
+geometry to FFmpeg for screen recording.
+
+FFcast version 1.0 rewritten from scratch, and incompatible with version 0.x.
+
+Usage
+-----
+
+Examples are always most helpful to get you started.
+
+ ffcast -s
+
+You will be asked to select a region using mouse, then ffmpeg starts recording.
+Press 'q' to end recording. The output file by default is ffcast-*.mkv.
+
+ ffcast -svv ffmpeg -r 25 -- -f alsa -i hw:0 -vcodec libx264 cast.mkv
+
+Debug is turned on by -vv. You will see in the debug output the ffmpeg command
+line that's called. Notice that '--' from above is replaced with the x11grab
+input options, and other options are unchanged- That's indeed what ffcast does.
+
+ ffcast -ws
+
+You will be asked to first select a window by mouse click, and then a screen
+region by mouse. The recorded region is the region selections combined by
+union. Indeed, you can pass any number of -w and -s.
+
+ DISPLAY=:1 ffcast
+
+FFcast, as with xwininfo, xrectsel, respects the DISPLAY environment variable.
+The above records the whole screen of display :1. This is useful when you run
+a nested X server with Xephyr and want to record stuff inside its window.
+
+FFcast 1.0 changes from 0.x
+---------------------------
+
+Many of the options are removed, and the code is considerably simplified and
+more readable. But the most significant change is that now the user can pass
+any valid argument to FFmpeg- FFcast will never touch FFmpeg's options other
+than the x11grab input ones (which is the point of FFcast). The implication
+of this is that, for example, you can easily pass audio input options to get
+audio recording- a feature widely expected yet hard to implement/maintain.
+
+The reasoning is that FFcast should not know anything about FFmpeg except for
+what it must know. In other words, I will not maintain the FFmpeg's crap,
+it's the user's responsibility to keep up with whatever FFmpeg changes. In
+other words, FFcast doesn't hold the user's hands but gives him/her all the
+control. Whatever works for you ;). The part FFcast does touch, however, is
+the x11grab input options- currently something like this:
+
+ -f x11grab -s 600x400 -i :0.0+100+100
+
+That's it.
+
+Also changed is the xrectsel program. It now supports several format strings.
+They are %x, %y, %X, %Y, %w, %h, %b and %d. Read the source code for details.
+
+History
+-------
+
+Originally, Michal Witkowski (Neuro) posted[1] "x264 Lossless Screencast Script"
+at ArchLinux forums. I then went on and heavily modified and extended the
+script, and finally released FFcast 0.x. The idea behind Neuro's script was to
+parse xwininfo's output and pass it to ffmpeg, so you can easily record a window
+by simply clicking it. I liked it, and naturally linked the behavior with the
+screenshot application 'scrot'. I wanted to find a way to select an arbitrary
+screen region for capture. I went on to look at the scrot source code, as well
+as post a topic[2] asking for help. HashBox was very kind to post his code and
+even clean it up for me- I finally combined what I got from scrot and HashBox's
+code and put togethor xrectsel.c. All was looking good to me.
+
+But obviously I was midguided to think it's a good idea to take control of all
+the irrelevant FFmpeg options and added even more (like -t). And then people
+came to me and complained that FFcast doesn't do sound recording. I at first
+still thought I should implement it, but then found that we simply couldn't-
+with all the sound systems out there, there's no easy way to determine the sound
+input device in the first place. I could have added some options in the config
+file and whatnot, but I *knew* I was on the wrong track, so I did nothing.
+
+After a long time, a thread[3] at ArchLinux forums reminded me of FFcast and
+the painful fact that it sucked. I then sat down, opened the script, and didn't
+read much before I started to write prototype code for FFcast 1.0.
+
+[1] https://bbs.archlinux.org/viewtopic.php?id=85237
+[2] https://bbs.archlinux.org/viewtopic.php?id=85378
+[3] https://bbs.archlinux.org/viewtopic.php?id=127335
+
+FAQ
+---
+
+Q: Why not support console recording?
+A: Since you asked, you probably know that ffmpeg can record framebuffer,
+ `ffmpeg -f fbdev -i /dev/fb0` for example. The thing is ffmpeg's framebuffer
+ recording is very primitive- it does not support region selection of any
+ kind, just the whole screen. Even if it did, we wouldn't be able to do the
+ same kind of interative selection as in X. Due to these limitations and
+ the goal of ffcast, the user is better off using ffmpeg directly.
+ I also recommend 'ttyrec' for your tty recording needs.
+
+Q: Can I record audio using ffcast?
+A: Yes, you can do everything you like with ffmpeg since ffcast 1.0.
+
2 TODO
@@ -0,0 +1,2 @@
+* Choose a decent set of default ffmpeg options- ask experts ;)
+* Add verbose and debug messages- never fail silently.
Oops, something went wrong.

0 comments on commit 314e513

Please sign in to comment.