diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..bde8f7429 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,181 @@ +# Changelog + +All notable changes to **pipecat** will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Other + +- Add missing dependencies in some of the examples. + +## [0.0.11] - 2024-05-13 + +### Added + +- Allow stopping pipeline tasks with new `StopTaskFrame`. + +### Changed + +- TTS, STT and image generation service now use `AsyncGenerator`. + +### Fixed + +- `DailyTransport`: allow registering for participant transcriptions even if + input transport is not initialized yet. + +### Other + +- Updated `storytelling-chatbot`. + +## [0.0.10] - 2024-05-13 + +### Added + +- Added Intel GPU support to `MoondreamService`. + +- Added support for sending transport messages (e.g. to communicate with an app + at the other end of the transport). + +- Added `FrameProcessor.push_error()` to easily send an `ErrorFrame` upstream. + +### Fixed + +- Fixed Azure services (TTS and image generation). + +### Other + +- Updated `simple-chatbot`, `moondream-chatbot` and `translation-chatbot` + examples. + +## [0.0.9] - 2024-05-12 + +### Changed + +Many things have changed in this version. Many of the main ideas such as frames, +processors, services and transports are still there but some things have changed +a bit. + +- `Frame`s describe the basic units for processing. For example, text, image or + audio frames. Or control frames to indicate a user has started or stopped + speaking. + +- `FrameProcessor`s process frames (e.g. they convert a `TextFrame` to an + `ImageRawFrame`) and push new frames downstream or upstream to their linked + peers. + +- `FrameProcessor`s can be linked together. The easiest wait is to use the + `Pipeline` which is a container for processors. Linking processors allow + frames to travel upstream or downstream easily. + +- `Transport`s are a way to send or receive frames. There can be local + transports (e.g. local audio or native apps), network transports + (e.g. websocket) or service transports (e.g. https://daily.co). + +- `Pipeline`s are just a processor container for other processors. + +- A `PipelineTask` know how to run a pipeline. + +- A `PipelineRunner` can run one or more tasks and it is also used, for example, + to capture Ctrl-C from the user. + +## [0.0.8] - 2024-04-11 + +### Added + +- Added `FireworksLLMService`. + +- Added `InterimTranscriptionFrame` and enable interim results in + `DailyTransport` transcriptions. + +### Changed + +- `FalImageGenService` now uses new `fal_client` package. + +### Fixed + +- `FalImageGenService`: use `asyncio.to_thread` to not block main loop when + generating images. + +- Allow `TranscriptionFrame` after an end frame (transcriptions can be delayed + and received after `UserStoppedSpeakingFrame`). + +## [0.0.7] - 2024-04-10 + +### Added + +- Add `use_cpu` argument to `MoondreamService`. + +## [0.0.6] - 2024-04-10 + +### Added + +- Added `FalImageGenService.InputParams`. + +- Added `URLImageFrame` and `UserImageFrame`. + +- Added `UserImageRequestFrame` and allow requesting an image from a participant. + +- Added base `VisionService` and `MoondreamService` + +### Changed + +- Don't pass `image_size` to `ImageGenService`, images should have their own size. + +- `ImageFrame` now receives a tuple`(width,height)` to specify the size. + +- `on_first_other_participant_joined` now gets a participant argument. + +### Fixed + +- Check if camera, speaker and microphone are enabled before writing to them. + +### Performance + +- `DailyTransport` only subscribe to desired participant video track. + +## [0.0.5] - 2024-04-06 + +### Changed + +- Use `camera_bitrate` and `camera_framerate`. + +- Increase `camera_framerate` to 30 by default. + +### Fixed + +- Fixed `LocalTransport.read_audio_frames`. + +## [0.0.4] - 2024-04-04 + +### Added + +- Added project optional dependencies [silero,openai,...]. + +### Changed + +- Moved thransports to its own directory. + +- Use `OPENAI_API_KEY` instead of `OPENAI_CHATGPT_API_KEY`. + +### Fixed + +- Don't write to microphone/speaker if not enabled. + +### Other + +- Added live translation example. + +- Fix foundational examples. + +## [0.0.3] - 2024-03-13 + +### Other + +- Added `storybot` and `chatbot` examples. + +## [0.0.2] - 2024-03-12 + +Initial public release. diff --git a/CHANGELOG.md.template b/CHANGELOG.md.template new file mode 100644 index 000000000..cdb7585b1 --- /dev/null +++ b/CHANGELOG.md.template @@ -0,0 +1,62 @@ +# Changelog + +All notable changes to the **<project name>** SDK will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +Please make sure to add your changes to the appropriate categories: + +## [Unreleased] + +### Added + + + +- n/a + +### Changed + + + +- n/a + +### Deprecated + + + +- n/a + +### Removed + + + +- n/a + +### Fixed + + + +- n/a + +### Performance + + + +- n/a + +### Security + + + +- n/a + +### Other + + + +- n/a + +## [0.1.0] - YYYY-MM-DD + +Initial release.