diff --git a/README.md b/README.md index 42a42ce..e7599b1 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ GifToSyphon requires Mac OS 10.9.5 or later. #History -In the process of replacing some old QuickTime movie playback code with AVFoundation counterparts I needed to write a test sandbox app for animated GIF playback as it isn't supported by AVPlayer. After it was written there was a secondary need to download lots of sample GIFs to test against to make sure everything worked properly. Thankful Giphy has a simple and free API for pulling images from their library. Once that was going it was pretty clear this needed to be published to Syphon so the GIF search could be accessed during live performances. +In the process of replacing some old QuickTime movie playback code with AVFoundation counterparts I needed to create a test sandbox app for animated GIF playback as it isn't a file format supported by AVPlayer. After it was written there was a secondary need to download lots of sample GIFs to test against to make sure everything worked properly. Thankful Giphy has a simple and free API for pulling images from their library. Once that was going it was pretty clear this needed to be published to Syphon so the GIF search could be accessed during live performances. #Compiling your own version @@ -23,14 +23,14 @@ https://github.com/mrRay/vvopensource The GIF playback code section is broken up into three objects: - VVGIFFrame: Wrapper for a single GIF frame. - VVGIFPlayerItem: Representation of an animated GIF file. Maintains an array of VVGIFFrames. -- VVGIFPlayer: Playback controller for animated GIF files. +- VVGIFPlayer: Playback controller for animated GIF files. Loads VVGIFPlayerItems. In the AppController you'll find the code for: -- A simple rendering engine based on VVBufferPool. In the render thread bitmaps are pulled from the VVGIFPlayer and converted into VVBuffers for display and publishing to Syphon. -- Handling the getting links to GIFs from Giphy. Uses VVCURLDL to make an asynchronous connection to request a random GIF and JSONKit to interpret the returned result. - Loading and interfacing with instances of a VVGIFPlayer. +- A simple rendering engine based on VVBufferPool. In the render thread bitmaps are pulled from the VVGIFPlayer and converted into VVBuffers for display and publishing to Syphon. +- Searching and getting links to GIFs from Giphy. Uses VVCURLDL to make an asynchronous connection to request a random GIF based on a search term and then JSONKit to interpret the returned result. -This code uses a public API key from Giphy – if you're serious about running your own fork of this project you'll want to get in touch with them to get your own private API key that can be placed in the AppController.h defines. For more information on the Giphy API visit their webpage here: https://api.giphy.com/ +Important note: This code uses a public API key from Giphy – if you're serious about running your own release fork of this project you'll want to get in touch with them to get your own private API key that can be placed in the AppController.h defines. For more information on the Giphy API visit their webpage here: https://api.giphy.com/ #Licensing